{"id":13847404,"url":"https://github.com/nestjs-steroids/async-context","last_synced_at":"2025-07-29T13:11:54.613Z","repository":{"id":44604268,"uuid":"276966493","full_name":"nestjs-steroids/async-context","owner":"nestjs-steroids","description":":link: NestJS Async Context based on async_hooks","archived":false,"fork":false,"pushed_at":"2023-10-17T11:14:56.000Z","size":641,"stargazers_count":45,"open_issues_count":8,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-08T21:09:52.277Z","etag":null,"topics":["async-context","asynchooks","asyncstorage","nestjs","nodejs","request-context","requestid"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nestjs-steroids.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-07-03T18:44:49.000Z","updated_at":"2024-12-28T19:20:51.000Z","dependencies_parsed_at":"2024-01-15T20:50:07.225Z","dependency_job_id":"634ca8f7-ecf9-4ad6-b53a-e977ac10c865","html_url":"https://github.com/nestjs-steroids/async-context","commit_stats":{"total_commits":26,"total_committers":3,"mean_commits":8.666666666666666,"dds":"0.34615384615384615","last_synced_commit":"c065f27c3af654b6c3ee4c914c51dc8b2697c8cb"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/nestjs-steroids/async-context","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestjs-steroids%2Fasync-context","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestjs-steroids%2Fasync-context/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestjs-steroids%2Fasync-context/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestjs-steroids%2Fasync-context/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nestjs-steroids","download_url":"https://codeload.github.com/nestjs-steroids/async-context/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestjs-steroids%2Fasync-context/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267693392,"owners_count":24129133,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async-context","asynchooks","asyncstorage","nestjs","nodejs","request-context","requestid"],"created_at":"2024-08-04T18:01:19.147Z","updated_at":"2025-07-29T13:11:54.548Z","avatar_url":"https://github.com/nestjs-steroids.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","Packages"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eAsync Context\u003c/h1\u003e\n\nZero-dependency module for NestJS that allow to track context between async call\n\n## Installation\n```bash\nnpm install @nestjs-steroids/async-context\nyarn add @nestjs-steroids/async-context\npnpm install @nestjs-steroids/async-context\n```\n\n## Usage\nThe first step is to register `AsyncContext` inside interceptor (or middleware)\n\u003e `src/async-context.interceptor.ts`\n```typescript\nimport { randomUUID } from 'crypto'\nimport {\n  Injectable,\n  NestInterceptor,\n  ExecutionContext,\n  CallHandler\n} from '@nestjs/common'\nimport { AsyncContext } from '@nestjs-steroids/async-context'\nimport { Observable } from 'rxjs'\n\n@Injectable()\nexport class AsyncContextInterceptor implements NestInterceptor {\n  constructor (private readonly ac: AsyncContext\u003cstring, any\u003e) {}\n\n  intercept (context: ExecutionContext, next: CallHandler): Observable\u003cany\u003e {\n    this.ac.register() // Important to call .register or .registerCallback (good for middleware)\n    this.ac.set('traceId', randomUUID()) // Setting default value traceId\n    return next.handle()\n  }\n}\n```\n\nThe second step is to register `AsyncContextModule` and interceptor inside main module\n\u003e `src/app.module.ts`\n```typescript\nimport { APP_INTERCEPTOR } from '@nestjs/core';\nimport { Module } from '@nestjs/common';\nimport { AsyncContextModule } from '@nestjs-steroids/async-context';\nimport { AsyncContextInterceptor } from './async-context.interceptor';\n\n@Module({\n  imports: [\n    AsyncContextModule.forRoot()\n  ],\n  providers: [\n    {\n      provide: APP_INTERCEPTOR,\n      useClass: AsyncContextInterceptor,\n    },\n  ],\n})\nexport class AppModule {}\n```\nThe last step is to inject `AsyncContext` inside controller or service and use it\n\u003e ``src/app.controller.ts``\n```typescript\nimport { Controller, Get, Logger } from '@nestjs/common'\nimport { AppService } from './app.service'\nimport { AsyncContext } from '@nestjs-steroids/async-context'\n\n@Controller()\nexport class AppController {\n  constructor (\n    private readonly appService: AppService,\n    private readonly asyncContext: AsyncContext\u003cstring, string\u003e,\n    private readonly logger: Logger\n  ) {}\n\n  @Get()\n  getHello (): string {\n    this.logger.log('AppController.getHello', this.asyncContext.get('traceId'))\n    process.nextTick(() =\u003e {\n      this.logger.log(\n        'AppController.getHello -\u003e nextTick',\n        this.asyncContext.get('traceId')\n      )\n      setTimeout(() =\u003e {\n        this.logger.log(\n          'AppController.getHello -\u003e nextTick -\u003e setTimeout',\n          this.asyncContext.get('traceId')\n        )\n      }, 0)\n    })\n    return this.appService.getHello()\n  }\n}\n\n```\n\n## Output example\n\n```\n[Nest] 141168  - 02/01/2022, 11:33:11 PM     LOG [NestFactory] Starting Nest application...\n[Nest] 141168  - 02/01/2022, 11:33:11 PM     LOG [InstanceLoader] AsyncContextModule dependencies initialized +47ms\n[Nest] 141168  - 02/01/2022, 11:33:11 PM     LOG [InstanceLoader] AppModule dependencies initialized +1ms\n[Nest] 141168  - 02/01/2022, 11:33:11 PM     LOG [RoutesResolver] AppController {/}: +12ms\n[Nest] 141168  - 02/01/2022, 11:33:11 PM     LOG [RouterExplorer] Mapped {/, GET} route +7ms\n[Nest] 141168  - 02/01/2022, 11:33:11 PM     LOG [NestApplication] Nest application successfully started +5ms\n[Nest] 141168  - 02/01/2022, 11:33:13 PM     LOG [7398d3ad-c246-4650-8dd0-f8f29238bdd7] AppController.getHello\n[Nest] 141168  - 02/01/2022, 11:33:13 PM     LOG [7398d3ad-c246-4650-8dd0-f8f29238bdd7] AppController.getHello -\u003e nextTick\n[Nest] 141168  - 02/01/2022, 11:33:13 PM     LOG [7398d3ad-c246-4650-8dd0-f8f29238bdd7] AppController.getHello -\u003e nextTick -\u003e setTimeout\n```\n\n## API\n\n### `AsyncContext` almost identical to native `Map` object\n```typescript\nclass AsyncContext {\n  // Clear all values from storage\n  clear(): void;\n\n  // Delete value by key from storage\n  delete(key: K): boolean;\n\n  // Iterate over storage\n  forEach(callbackfn: (value: V, key: K, map: Map\u003cK, V\u003e) =\u003e void, thisArg?: any): void;\n\n  // Get value from storage by key\n  get(key: K): V | undefined;\n\n  // Check if key exists in storage\n  has(key: K): boolean;\n\n  // Set value by key in storage\n  set(key: K, value: V): this;\n\n  // Get number of keys that stored in storage\n  get size: number;\n\n  // Register context, it's better to use this method inside the interceptor\n  register(): void\n\n  // Register context for a callback, it's better to use this inside the middleware\n  registerCallback\u003cR, TArgs extends any[]\u003e(callback: (...args: TArgs) =\u003e R, ...args: TArgs): R\n\n  // Unregister context\n  unregister(): void\n}\n\n```\n### `AsyncContextModule`\n```typescript\ninterface AsyncContextModuleOptions {\n  // Should register this module as global, default: true\n  isGlobal?: boolean\n\n  // In case if you need to provide custom value AsyncLocalStorage\n  alsInstance?: AsyncLocalStorage\u003cany\u003e\n}\n\nclass AsyncContextModule {\n  static forRoot (options?: AsyncContextModuleOptions): DynamicModule\n}\n```\n\n## Migration guide from V1\nYou need to replace `AsyncHooksModule` by `AsyncContextModule.forRoot()`\n\n## License\n[MIT](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnestjs-steroids%2Fasync-context","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnestjs-steroids%2Fasync-context","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnestjs-steroids%2Fasync-context/lists"}