From 74bfa27094b55645535793e9bdf6da024c50194e Mon Sep 17 00:00:00 2001 From: Zoe Codez Date: Thu, 19 Sep 2024 21:09:58 -0500 Subject: [PATCH] comments --- src/services/wiring.extension.ts | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/src/services/wiring.extension.ts b/src/services/wiring.extension.ts index 066762e..7842897 100644 --- a/src/services/wiring.extension.ts +++ b/src/services/wiring.extension.ts @@ -121,9 +121,36 @@ function createBoilerplate() { name: "boilerplate", priorityInit: ["als", "configuration", "logger", "scheduler"], services: { + /** + * [AsyncLocalStorage](https://nodejs.org/api/async_context.html) hooks + * + * Use to pass data around bypassing business logic and insert data into logs + */ als: ALS, + + /** + * @internal + * + * Exposed via `internal.boilerplate.configuration` + * + * Used to directly modify application configuration + */ configuration: Configuration, + + /** + * @internal + * + * Exposed via `internal.boilerplate.logger` + * + * Used to modify the way the logger works at runtime + */ logger: Logger, + + /** + * @internal + * + * Used to generate the scheduler that will get injected into other services + */ scheduler: Scheduler, }, });