@travetto/context 3.0.2 → 3.1.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +4 -3
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  <!-- This file was generated by @travetto/doc and should not be modified directly -->
2
- <!-- Please modify https://github.com/travetto/travetto/tree/main/module/context/DOC.ts and execute "npx trv doc" to rebuild -->
2
+ <!-- Please modify https://github.com/travetto/travetto/tree/main/module/context/DOC.tsx and execute "npx trv doc" to rebuild -->
3
3
  # Async Context
4
+
4
5
  ## Async-aware state management, maintaining context across asynchronous calls.
5
6
 
6
7
  **Install: @travetto/context**
@@ -12,9 +13,9 @@ npm install @travetto/context
12
13
  yarn add @travetto/context
13
14
  ```
14
15
 
15
- This module provides a wrapper around node's [async_hooks](https://nodejs.org/api/async_hooks.html) to maintain context across async calls. This is generally used for retaining contextual user information at various levels of async flow.
16
+ This module provides a wrapper around node's [async_hooks](https://nodejs.org/api/async_hooks.html) to maintain context across async calls. This is generally used for retaining contextual user information at various levels of async flow.
16
17
 
17
- The most common way of utilizing the context, is via the [WithAsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/decorator.ts#L6) decorator. The decorator requires the class it's being used in, to have a [AsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/service.ts#L14) member, as it is the source of the contextual information.
18
+ The most common way of utilizing the context, is via the [WithAsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/decorator.ts#L6) decorator. The decorator requires the class it's being used in, to have a [AsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/service.ts#L14) member, as it is the source of the contextual information.
18
19
 
19
20
  The decorator will load the context on invocation, and will keep the context active during the entire asynchronous call chain.
20
21
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@travetto/context",
3
- "version": "3.0.2",
3
+ "version": "3.1.0-rc.0",
4
4
  "description": "Async-aware state management, maintaining context across asynchronous calls.",
5
5
  "keywords": [
6
6
  "async-hooks",
@@ -26,10 +26,10 @@
26
26
  "directory": "module/context"
27
27
  },
28
28
  "dependencies": {
29
- "@travetto/di": "^3.0.2"
29
+ "@travetto/di": "^3.1.0-rc.0"
30
30
  },
31
31
  "peerDependencies": {
32
- "@travetto/test": "^3.0.2"
32
+ "@travetto/test": "^3.1.0-rc.0"
33
33
  },
34
34
  "peerDependenciesMeta": {
35
35
  "@travetto/test": {