diff options
Diffstat (limited to 'client/node_modules/defer-to-connect/README.md')
| -rw-r--r-- | client/node_modules/defer-to-connect/README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/client/node_modules/defer-to-connect/README.md b/client/node_modules/defer-to-connect/README.md new file mode 100644 index 0000000..4dd36c2 --- /dev/null +++ b/client/node_modules/defer-to-connect/README.md @@ -0,0 +1,38 @@ +# defer-to-connect + +> The safe way to handle the `connect` socket event + +[](https://coveralls.io/github/szmarczak/defer-to-connect?branch=master) + +Once you receive the socket, it may be already connected (or disconnected).<br> +To avoid checking that, use `defer-to-connect`. It'll do that for you. + +## Usage + +```js +const deferToConnect = require('defer-to-connect'); + +deferToConnect(socket, () => { + console.log('Connected!'); +}); +``` + +## API + +### deferToConnect(socket, connectListener) + +Calls `connectListener()` when connected. + +### deferToConnect(socket, listeners) + +#### listeners + +An object representing `connect`, `secureConnect` and `close` properties. + +Calls `connect()` when the socket is connected.<br> +Calls `secureConnect()` when the socket is securely connected.<br> +Calls `close()` when the socket is destroyed. + +## License + +MIT |