You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@travetto/context

Package Overview
Dependencies
1
Maintainers
0
Versions
271
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@travetto/context

Async-aware state management, maintaining context across asynchronous calls.


Version published
Weekly downloads
215
increased by9.69%
Maintainers
0
Created
Weekly downloads
 

Readme

Source

Async Context

Async-aware state management, maintaining context across asynchronous calls.

Install: @travetto/context

npm install @travetto/context

# or

yarn add @travetto/context

This module provides a wrapper around node's async_hooks to maintain context across async calls. This is generally used for retaining contextual user information at various levels of async flow.

The most common way of utilizing the context, is via the WithAsyncContext decorator. The decorator requires the class it's being used in, to have a AsyncContext member, as it is the source of the contextual information.

The decorator will load the context on invocation, and will keep the context active during the entire asynchronous call chain.

Code: Usage of context within a service

import { AsyncContext, WithAsyncContext } from '@travetto/context';

export class ContextAwareService {

  constructor(public context: AsyncContext) { }

  @WithAsyncContext()
  async complexOperator(name: string) {
    this.context.set({ name });
    await this.additionalOp('extra');
    await this.finalOp();
  }

  async additionalOp(additional: string) {
    const { name } = this.context.get();
    this.context.set({ name: `${name} ${additional}` });
  }

  async finalOp() {
    const { name } = this.context.get();
    // Use name
    return name;
  }
}

The decorator also allows for a priming of the contextual information. This is generally useful for system generated operations that are not initiated by a user.

Code: Usage of context within a service

import { AsyncContext, WithAsyncContext } from '@travetto/context';

export class SystemInitiatedContext {

  constructor(public context: AsyncContext) { }

  @WithAsyncContext({
    user: 'system',
    uid: 20
  })
  async runJob(name: string) {
    console.log('Running', { user: this.context.get().user, jobName: name });
  }
}

Keywords

FAQs

Package last updated on 20 Jun 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc