Types.

Author: odeadglaz

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 3.0.1 (February 12, 2021)
+
+- Better `types.d`.
+
 ## 3.0.0 (January 03, 2021)
 
 - Introduces `AsyncLocaleStorage` based implementation for node `12.7.0` and above.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-execution-context",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Provides execution context wrapper for node JS, can be used to create execution wrapper for handling requests and more",
   "author": "Oded Goldglas <odedglas@gmail.com>",
   "license": "ISC",
@@ -10,6 +10,7 @@
   },
   "homepage": "https://github.com/odedglas/node-execution-context",
   "main": "dist/index.js",
+  "types": "src/types.d.ts",
   "scripts": {
     "test": "jest -c configuration/jest.config.js",
     "lint": "eslint .",

src/ExecutionContext/types.d.ts

@@ -15,52 +15,8 @@ interface ExecutionContextConfig {
     monitor: boolean;
 }
 
-interface ExecutionContextAPI {
-
-    /**
-     * Creates a given context for the current asynchronous execution.
-     * Note that if this method will be called not within a AsyncResource context, it will effect current execution context.
-     * @param context - The context to expose.
-     */
-    create(context: unknown): void;
-
-    /**
-     * Sets the current asynchronous execution context to given value.
-     * @param context - The new context to expose current asynchronous execution.
-     */
-    set(context: unknown): void;
-
-    /**
-     * Gets the current asynchronous execution context.
-     */
-    get<T>(): T;
-
-    /**
-     * Runs given callback that will be exposed to the given context.
-     * This will expose the given context within all callbacks and promise chains that will be called from given fn.
-     * @param fn - The function to run.
-     * @param context - The context to expose.
-     */
-    run(fn: Function, context: unknown): unknown;
-
-    /**
-     * Configures current execution context manager.
-     * [Note] Relevant for node v12.17.0 and below
-     * @param config - the configuration to use.
-     */
-    config(config: ExecutionContextConfig): void;
-
-    /**
-     * Monitors current execution map usage
-     * [Note] Relevant for node v12.17.0 and below
-     * @return {ExecutionMapUsage|undefined}
-     */
-    monitor(): ExecutionMapUsage|undefined;
-}
-
 export {
     ExecutionContextNode,
     ExecutionContextMap,
-    ExecutionContextAPI,
     ExecutionContextConfig
 }

src/types.d.ts

@@ -1,3 +1,60 @@
-export * from './lib/types';
-export * from './managers/asyncHooks/hooks/types';
-export * from './ExecutionContext/types';
+import { ExecutionMapUsage, ExecutionMapUsageEntry } from './lib/types';
+import { HookCallbacks } from './managers/asyncHooks/hooks/types';
+import { ExecutionContextConfig, ExecutionContextNode, ExecutionContextMap } from './ExecutionContext/types';
+
+interface ExecutionContextAPI {
+
+    /**
+     * Creates a given context for the current asynchronous execution.
+     * Note that if this method will be called not within a AsyncResource context, it will effect current execution context.
+     * @param context - The context to expose.
+     */
+    create(context: unknown): void;
+
+    /**
+     * Sets the current asynchronous execution context to given value.
+     * @param context - The new context to expose current asynchronous execution.
+     */
+    set(context: unknown): void;
+
+    /**
+     * Gets the current asynchronous execution context.
+     */
+    get<T>(): T;
+
+    /**
+     * Runs given callback that will be exposed to the given context.
+     * This will expose the given context within all callbacks and promise chains that will be called from given fn.
+     * @param fn - The function to run.
+     * @param context - The context to expose.
+     */
+    run<T>(fn: () => T, context: unknown): T;
+
+    /**
+     * Configures current execution context manager.
+     * [Note] Relevant for node v12.17.0 and below
+     * @param config - the configuration to use.
+     */
+    config(config: ExecutionContextConfig): void;
+
+    /**
+     * Monitors current execution map usage
+     * [Note] Relevant for node v12.17.0 and below
+     * @return {ExecutionMapUsage|undefined}
+     */
+    monitor(): ExecutionMapUsage|undefined;
+}
+
+declare const context: ExecutionContextAPI;
+
+export {
+    HookCallbacks,
+    ExecutionMapUsageEntry,
+    ExecutionMapUsage,
+    ExecutionContextMap,
+    ExecutionContextNode,
+    ExecutionContextConfig,
+    ExecutionContextAPI
+};
+
+export default context;