# socket.io-token

**Repository Path**: devilky/socket-io-token

## Basic Information

- **Project Name**: socket.io-token
- **Description**: 这个项目就是socket.io的Token验证中间件。:)
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2017-05-25
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Socket.io token middleware

socket.io token verification middleware

## Usage：

### NPM
```bash
npm install --save socket.io-token
```

### example
```javascript

const io = require("socket.io")
const socketToken = require("socket.io-token")

io.on("connection", (socket) => {
    socket.use(socketToken({
        query: "token",
        verifyFuntional: (token, callback) => {
            if (true) { // success
                callback(true);
            } else { // fail
                callback(false);
            }
            //...
        }
    }))
})

```

## Options:

 - **verifyFuntional** *(Function)* custom verify function.
 - **query** *(String)* socket.io-client query key name.
 - **token** *(Stirng)* 自己手动获取的token
 - **secretOrPublicKey** *(String)*

## changelog

 - 1.0.1 Fix error
 - 1.0.2 Fix docs