@opengeekslab_llc/nest-custom-logger - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

package.json

 {
   "name": "@opengeekslab_llc/nest-custom-logger",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Logger that throw to output json logs",
@@ -5,0 +5,0 @@ "main": "src/index.ts",

README.md

@@ -1,1 +0,44 @@
-# nest-custom-logger
+# nest-custom-logger
+
+---
+## Usage
+
+---
+### Simple usage
+```ts
+import { Logger } from '@opengeekslab_llc/nest-custom-logger';
+
+const logger = new Logger(!process.env.NODE_ENV)('Hello');
+logger.log('World')
+```
+---
+### Extended usage
+```ts
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+import { Logger, requestLoggerMiddleware } from '@opengeekslab_llc/nest-custom-logger';
+
+const port = 8000;
+
+function CustomLogger(context: string) {
+  return new Logger(!process.env.NODE_ENV)(context);
+}
+
+async function bootstrap() {
+  const logger = CustomLogger('NEST');
+
+  const app = await NestFactory.create(AppModule, {
+    logger,
+  });
+
+  // use this middleware to show http logs in your console
+  app.use(requestLoggerMiddleware);
+
+  await app.listen(port);
+
+  logger.log(`app is listening on port ${port}`);
+}
+
+bootstrap();
+```
+

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5393

increased by18.58%

Number of lines in readme file

45

increased by4400%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes