@zthun/lumberjacky-nest 1.2.0 → 1.3.0

package/dist/types/logger/logger-module.d.ts

@@ -1,3 +1,21 @@
+/**
+ * The symbol to use with {@link @nestjs/common#Inject} to add a lumberjacky logger to your service.
+ */
 export declare const ZLoggerToken: unique symbol;
+/**
+ * This is the main entrypoint module that injects a default implementation of the logger.
+ *
+ * @example
+ *
+ * ```ts
+ * import { Module } from '@nestjs/common';
+ * import { ZLoggerModule} from '@zthun/lumberjacky-nest';
+ *
+ * @Module({
+ *  imports: [ZLoggerModule]
+ * })
+ * export class MyModule{ }
+ * ```
+ */
 export declare class ZLoggerModule {
 }

package/dist/types/logger/logger-nest.d.ts

@@ -1,4 +1,28 @@
 import { IZLogEntry, IZLogger } from '@zthun/lumberjacky-log';
+/**
+ * Represents the logger for nestjs.
+ *
+ * You will import this through the {@link ZLoggerModule} object.
+ *
+ * You can use this in conjunction with the {@link @zthun/lumberjacky-log#ZLoggerContext} object.
+ *
+ *
+ * @example
+ *
+ * ```ts
+ * import { Injectable, Inject } from '@nestjs/common';
+ * import { LoggerToken } from '@zthun/lumberjacky-nest';
+ *
+ * @Injectable
+ * public class MyService {
+ *     private _logger: IZLogger;
+ *
+ *     public constructor(@Inject(LoggerToken) logger: IZLogger) {
+ *         this._logger = new ZLoggerContext('MyService', logger);
+ *     }
+ * }
+ * ```
+ */
 export declare class ZLoggerNest implements IZLogger {
     private _logger;
     private _levelMap;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zthun/lumberjacky-nest",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "A lumberjacky log that integrates with the nest framework.",
   "author": "Anthony Bonta",
   "license": "MIT",
@@ -19,24 +19,27 @@
     "access": "public"
   },
   "dependencies": {
-    "@zthun/lumberjacky-log": "^1.2.0",
+    "@zthun/lumberjacky-log": "^1.3.0",
     "lodash": "^4.17.21",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
-    "@nestjs/common": "^10.2.4",
-    "@nestjs/core": "^10.2.4",
-    "@nestjs/platform-express": "^10.2.4",
-    "@nestjs/testing": "^10.2.4",
+    "@nestjs/common": "^10.2.10",
+    "@nestjs/core": "^10.2.10",
+    "@nestjs/platform-express": "^10.2.10",
+    "@nestjs/testing": "^10.2.10",
     "microbundle": "^0.15.1",
-    "typescript": "^5.2.2",
-    "vitest": "^0.34.4",
-    "vitest-mock-extended": "^1.2.1"
+    "typescript": "^5.3.2",
+    "vitest": "^0.34.6",
+    "vitest-mock-extended": "^1.3.1"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^10.2.4"
   },
   "files": [
     "dist"
   ],
   "sideEffects": false,
-  "gitHead": "a999ff9cbe8a8e8ef6bead842be1b45fb42970eb"
+  "gitHead": "890029ebc85b108b7ac841806df84bca3070869a"
 }