cheykrym/socket.io-client-swift
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Erik Little 2015-01-19 19:49:54 -05:00
parent 66b5def6c0
commit 8ecf5a986a
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -11,6 +11,14 @@ Installation
Use Use
=== ===
Methods
-------
1. `socket.on(name:String, callback:((data:AnyObject?) -> Void))` - Adds a handler for an event.
2. `socket.onMultipleArgs(name:String, callback:((data:[AnyObject]) -> Void))` - Adds a handler for an event that can have multiple items. Items are stored in an array.
3. `socket.emit(event:String, args:AnyObject? = nil)` - Sends an event with optional arg.
4. `socket.emitMultiple(event:String, args:AnyObject...)` - Sends an event with multiple args.
5. `socket.connect()` - Establishes a connection to the server. A "connect" event is fired upon successful connection.
6. `socket.close()` - Closes the socket. Once a socket is closed it should not be reopened.
```swift ```swift
// opts can be omitted, will use default values // opts can be omitted, will use default values