summaryrefslogtreecommitdiff
path: root/includes/external/addressbook/node_modules/defer-to-connect/README.md
diff options
context:
space:
mode:
authorRaindropsSys <raindrops@equestria.dev>2023-11-17 23:25:29 +0100
committerRaindropsSys <raindrops@equestria.dev>2023-11-17 23:25:29 +0100
commit953ddd82e48dd206cef5ac94456549aed13b3ad5 (patch)
tree8f003106ee2e7f422e5a22d2ee04d0db302e66c0 /includes/external/addressbook/node_modules/defer-to-connect/README.md
parent62a9199846b0c07c03218703b33e8385764f42d9 (diff)
downloadpluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.tar.gz
pluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.tar.bz2
pluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.zip
Updated 30 files and deleted 2976 files (automated)
Diffstat (limited to 'includes/external/addressbook/node_modules/defer-to-connect/README.md')
-rw-r--r--includes/external/addressbook/node_modules/defer-to-connect/README.md38
1 files changed, 0 insertions, 38 deletions
diff --git a/includes/external/addressbook/node_modules/defer-to-connect/README.md b/includes/external/addressbook/node_modules/defer-to-connect/README.md
deleted file mode 100644
index 4dd36c2..0000000
--- a/includes/external/addressbook/node_modules/defer-to-connect/README.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# defer-to-connect
-
-> The safe way to handle the `connect` socket event
-
-[![Coverage Status](https://coveralls.io/repos/github/szmarczak/defer-to-connect/badge.svg?branch=master)](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