chore(release): v2.0.0
This commit is contained in:
parent
a14d4e937b
commit
ad86800d8c
36
CHANGELOG.md
36
CHANGELOG.md
@ -1,5 +1,41 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## [2.0.0](https://github.com/Thream/socketio-jwt/compare/v1.1.1...v2.0.0) (2021-02-22)
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- usage of auth option to send credentials ([a14d4e9](https://github.com/Thream/socketio-jwt/commit/a14d4e937b764fdf4fb6b173c55b6f49688766dd))
|
||||||
|
|
||||||
|
See: <https://socket.io/docs/v3/middlewares/#Sending-credentials>
|
||||||
|
|
||||||
|
### BREAKING CHANGES
|
||||||
|
|
||||||
|
- `extraHeaders` with `Authorization` doesn't work anymore
|
||||||
|
|
||||||
|
### Migration
|
||||||
|
|
||||||
|
You need to change the way to connect client side.
|
||||||
|
|
||||||
|
Before :
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { io } from 'socket.io-client'
|
||||||
|
|
||||||
|
const socket = io('http://localhost:9000', {
|
||||||
|
extraHeaders: { Authorization: `Bearer ${yourJWT}` }
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
After :
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { io } from 'socket.io-client'
|
||||||
|
|
||||||
|
const socket = io('http://localhost:9000', {
|
||||||
|
auth: { token: `Bearer ${yourJWT}` }
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
## [1.1.1](https://github.com/Thream/socketio-jwt/compare/v1.1.0...v1.1.1) (2021-01-28)
|
## [1.1.1](https://github.com/Thream/socketio-jwt/compare/v1.1.0...v1.1.1) (2021-01-28)
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@thream/socketio-jwt",
|
"name": "@thream/socketio-jwt",
|
||||||
"version": "1.1.1",
|
"version": "2.0.0",
|
||||||
"description": "Authenticate socket.io incoming connections with JWTs.",
|
"description": "Authenticate socket.io incoming connections with JWTs.",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"main": "build/index.js",
|
"main": "build/index.js",
|
||||||
|
Reference in New Issue
Block a user