https://github.com/szmarczak/defer-to-connect

The safe way to handle the `connect` socket event
https://github.com/szmarczak/defer-to-connect

connect nodejs socket

Last synced: 17 days ago
JSON representation

The safe way to handle the `connect` socket event

• Host: GitHub
• URL: https://github.com/szmarczak/defer-to-connect
• Owner: szmarczak
• License: mit
• Created: 2018-08-13T16:10:54.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-05-12T09:23:11.000Z (over 3 years ago)
• Last Synced: 2024-10-19T14:48:23.519Z (25 days ago)
• Topics: connect, nodejs, socket
• Language: TypeScript
• Homepage:
• Size: 23.4 KB
• Stars: 9
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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).


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.


Calls `secureConnect()` when the socket is securely connected.


Calls `close()` when the socket is destroyed.

## License

MIT