github/socket.io
1
1
Fork 0
mirror of https://github.com/socketio/socket.io.git synced 2026-01-10 15:37:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

[feature] Allow the use of custom parsers (#2829)

Browse Source
This commit is contained in:
Damien Arrachequesne
2017-01-24 07:10:19 +01:00
committed by GitHub
parent 3d695c60f1
commit 3b92cc2b26
3 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/API.md
View File

@@ -68,6 +68,7 @@ Exposed by `require('socket.io')`.
- `adapter` _(Adapter)_: the adapter to use. Defaults to an instance of the `Adapter` that ships with socket.io which is memory based. See [socket.io-adapter](https://github.com/socketio/socket.io-adapter)
- `origins` _(String)_: the allowed origins (`*`)
- `allowRequest` _(Function)_: A function that receives a given handshake or upgrade request as its first parameter, and can decide whether to continue or not. The second argument is a function that needs to be called with the decided information: `fn(err, success)`, where `success` is a boolean value where false means that the request is rejected, and err is an error code.
- `parser` _(Parser)_: the parser to use. Defaults to an instance of the `Parser` that ships with socket.io. See [socket.io-parser](https://github.com/socketio/socket.io-parser).
Works with and without `new`: