Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@emartech/cls-adapter
Advanced tools
Readme
A wrapper around the Continuation Local Storage library cls-hooked. Makes storing and retrieving of context dependent information easier. It acts as a thread aware storage.
When a value is set on the storage with a given key, that value will be available inside functions calls from the parent function.
npm install @emartech/cls-adapter
const Koa = require('koa');
const ClsAdapter = require('@emartech/cls-adapter');
const logWithStorage = (message) => {
console.log(Object.assign({ message }, ClsAdapter.getContextStorage()));
};
const calculationResult = () => {
logWithStorage(100);
};
const app = new Koa();
app.use(ClsAdapter.getKoaMiddleware());
app.use(async (ctx) => {
ClsAdapter.setOnContext('customer_id', 1000);
logWithStorage('works');
// { message: 'works', request_id: 'd5caaa0e-b04e-4d94-bc88-3ed3b62dc94a' }
calculationResult();
// { message: 100, request_id: 'd5caaa0e-b04e-4d94-bc88-3ed3b62dc94a' }
ctx.body = 'It works';
});
app.listen(3000);
Returns a middleware function compatible with Koa that stores (or generates if missing)
the request identifier from the header (X-Request-Id) and sets it on the storage as request_id
.
const app = new Koa();
app.use(ClsAdapter.getKoaMiddleware());
app.use(async () => {
ClsAdapter.getContextStorage();
// { request_id: 'd5caaa0e-b04e-4d94-bc88-3ed3b62dc94a' }
});
Returns a middleware function compatible with Express that stores (or generates if missing)
the request identifier from the header (X-Request-Id) and sets it on the storage as request_id
.
const app = express();
app.use(ClsAdapter.getExpressMiddleware());
app.use(() => {
ClsAdapter.getContextStorage();
// { request_id: 'd5caaa0e-b04e-4d94-bc88-3ed3b62dc94a' }
});
Returns the all the values set on the storage.
Sets a key with a given value on the storage.
ClsAdapter.setOnContext('customer_id', 1);
ClsAdapter.setOnContext('application.customer.id', 11);
ClsAdapter.getContextStorage();
// { customer_id: 1, application: { customer: { id: 11 } } }
Returns the the request identifier set on the storage. The identifiers key is request_id
.
ClsAdapter.setOnContext('request_id', 'd5caaa0e-b04e-4d94-bc88-3ed3b62dc94a');
ClsAdapter.getRequestId();
// 'd5caaa0e-b04e-4d94-bc88-3ed3b62dc94a'
Returns a function that extends the given object with the current storage.
ClsAdapter.setOnContext('customer_id', 1);
ClsAdapter.addContextStorageToInput()({ debug: true });
// { debug: true, customer_id: 1 }
Returns a function that extends the given object with the request identifier set on the current storage.
ClsAdapter.setOnContext('request_id', 'd5caaa0e-b04e-4d94-bc88-3ed3b62dc94a');
ClsAdapter.addRequestIdToInput()({ debug: true });
// { debug: true, request_id: 'd5caaa0e-b04e-4d94-bc88-3ed3b62dc94a' }
FAQs
Continuation Local Storage made easy
The npm package @emartech/cls-adapter receives a total of 367 weekly downloads. As such, @emartech/cls-adapter popularity was classified as not popular.
We found that @emartech/cls-adapter demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 217 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.