https://github.com/shfshanyue/cls-session
a cls session impletation using async_hooks
https://github.com/shfshanyue/cls-session
async-hooks context logger trace
Last synced: about 1 year ago
JSON representation
a cls session impletation using async_hooks
- Host: GitHub
- URL: https://github.com/shfshanyue/cls-session
- Owner: shfshanyue
- Created: 2020-03-15T10:39:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T01:46:29.000Z (over 3 years ago)
- Last Synced: 2024-04-15T04:27:34.592Z (about 2 years ago)
- Topics: async-hooks, context, logger, trace
- Language: TypeScript
- Homepage:
- Size: 697 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
[](https://nodei.co/npm/cls-session/)
# cls-session
[](https://www.npmjs.org/package/cls-session)
[](https://packagephobia.now.sh/result?p=cls-session)
[](http://npm-stat.com/charts.html?package=cls-session)
Continuation Local Storage works like thread-local storage in threaded programming. This is a implementation of CLS using async_hooks instead of async-listener.
## Installation
It requires node v8.2.1 or higher for ES2015 and async_hooks support.
``` bash
$ npm install cls-session
```
## Usage
``` js
const Session = require('cls-session')
const session = new Session()
function timeout (id) {
session.scope(() => {
session.set('a', id)
setTimeout(() => {
const a = session.get('a')
console.log(a)
})
})
}
timeout(1)
timeout(2)
timeout(3)
// Output:
// 1
// 2
// 3
```
## Middleware in koa
``` js
import Session from 'cls-session'
import Koa from 'koa'
const app = new Koa()
const session = new Session()
app.use(session.middleware())
app.use(async (ctx, next) => {
session.set('userId', 10086)
await next()
})
app.use((ctx) => {
const userId = session.get('userId')
ctx.body = userId
})
app.listen(3200)
```
## Middleware in express
``` js
import Session from 'cls-session'
import express from 'express'
const app = express()
const session = new Session()
app.use(session.expressMiddleware())
app.use((req, res, next) => {
session.set('userId', 10086)
next()
})
app.use((req, res, next) => {
const userId = session.get('userId')
res.send(userId)
})
app.listen(3200, () => {
console.log('Listen 3200')
})
```
## API
### session.scope(callback: () => Promise | any): Promise
Create a new context on which values can be set or read.Run all the functions that are called (either directly, or indirectly through asynchronous functions that take callbacks themselves) from the provided callback within the scope.
### session.set(key: any, value: any)
Set a value on the current continuation context.
### session.get(key: any): any
Get a value on the current continuation context.
### session.middleware()
A middleware of koa.
### session.expressMiddleware()
A middleware of express.
### session.context: Map
### session.size: number