@tsed/logger - npm Package Compare versions

Comparing version 5.2.0 to 5.2.1

lib/appenders/class/BaseAppender.d.ts

@@ -57,3 +57,3 @@ /**
     constructor(_config: IAppenderConfiguration);
-    get config(): IAppenderConfiguration;
+    readonly config: IAppenderConfiguration;
     configure(config: PartialAppenderConfiguration): this;
@@ -60,0 +60,0 @@ /**

lib/appenders/components/ConsoleAppender.js

@@ -34,2 +34,29 @@ "use strict";
 let ConsoleAppender = class ConsoleAppender extends BaseAppender_1.BaseAppender {
+    /**
+     * ## Console Appender
+     *
+     * This appender uses node’s console object to write log events. It can also be used in the browser, if you’re using browserify or something similar. Be aware that writing a high volume of output to the console can make your application use a lot of memory. If you experience this problem, try switching to the stdout appender.
+     *
+     * ## Configuration
+     *
+     * * type - console
+     * * layout - object (optional, defaults to colouredLayout) - see layouts
+     *
+     * Note that all log events are output using console.log regardless of the event’s level (so ERROR events will not be logged using console.error)
+     *
+     * ## Example
+     *
+     * ```typescript
+     * import {Logger} from "ts-log-debug";
+     *
+     * const logger = new Logger("loggerName");
+     *
+     * logger.appenders.set("console", {
+     *     type: "console",
+     *     levels: ["debug", "info", "trace"]
+     * });
+     * ```
+     *
+     * @private
+     */
     constructor() {
@@ -36,0 +63,0 @@ super(...arguments);

lib/appenders/components/StderrAppender.js

@@ -32,2 +32,27 @@ "use strict";
 let StderrAppender = class StderrAppender extends BaseAppender_1.BaseAppender {
+    /**
+     * ## Standard Error Appender
+     *
+     * This appender writes all log events to the standard error stream.
+     *
+     * ## Configuration
+     *
+     * * type - stderr
+     * * layout - object (optional, defaults to colouredLayout) - see layouts
+     *
+     * ## Example
+     *
+     * ```typescript
+     * import {Logger} from "ts-log-debug";
+     *
+     * const logger = new Logger("loggerName");
+     *
+     * logger.appenders.set("log-error", {
+     *     type: "stderr",
+     *     levels: ["error", "warn", "fatal"]
+     * });
+     * ```
+     *
+     * @private
+     */
     constructor() {
@@ -34,0 +59,0 @@ super(...arguments);

lib/appenders/components/StdoutAppender.js

@@ -32,2 +32,27 @@ "use strict";
 let StdoutAppender = class StdoutAppender extends BaseAppender_1.BaseAppender {
+    /**
+     * ## Standard Output Appender
+     *
+     * This appender writes all log events to the standard output stream.
+     *
+     * ## Configuration
+     *
+     * * type - stderr
+     * * layout - object (optional, defaults to colouredLayout) - see layouts
+     *
+     * ## Example
+     *
+     * ```typescript
+     * import {Logger} from "ts-log-debug";
+     *
+     * const logger = new Logger("loggerName");
+     *
+     * logger.appenders.set("log", {
+     *     type: "stdout",
+     *     levels: ["info", "trace", "debug"]
+     * });
+     * ```
+     *
+     * @private
+     */
     constructor() {
@@ -34,0 +59,0 @@ super(...arguments);

lib/core/LogEvent.d.ts

@@ -21,10 +21,10 @@ /**
     private _startTime;
-    get startTime(): Date;
-    get categoryName(): string;
-    get level(): LogLevel;
-    get formatedLevel(): string;
-    get data(): any[];
-    get context(): Map<string, any>;
-    get cluster(): any;
-    get pid(): any;
+    readonly startTime: Date;
+    readonly categoryName: string;
+    readonly level: LogLevel;
+    readonly formatedLevel: string;
+    readonly data: any[];
+    readonly context: Map<string, any>;
+    readonly cluster: any;
+    readonly pid: any;
 }

lib/logger/class/Logger.d.ts

@@ -11,6 +11,5 @@ import { LoggerAppenders } from "./LoggerAppenders";
     private _appenders;
-    get appenders(): LoggerAppenders;
+    readonly appenders: LoggerAppenders;
     private _level;
-    get level(): string;
-    set level(level: string);
+    level: string;
     /**
@@ -20,5 +19,4 @@ *
     private _context;
-    get context(): Map<any, any>;
-    get name(): string;
-    set name(value: string);
+    readonly context: Map<any, any>;
+    name: string;
     /**
@@ -25,0 +23,0 @@ * Create stack trace  the lines of least Logger.

lib/logger/class/LoggerAppenders.d.ts

@@ -12,3 +12,3 @@ import { BaseAppender } from "../../appenders/class/BaseAppender";
     private _lvls;
-    get size(): number;
+    readonly size: number;
     /**
@@ -15,0 +15,0 @@ * The `has() method returns a boolean indicating whether an element with the specified configuration name exists or not.

package.json

 {
   "name": "@tsed/logger",
-  "version": "5.2.0",
+  "version": "5.2.1",
   "description": "A multi channel logger written in TypeScript.",
@@ -14,3 +14,3 @@ "main": "lib/index.js",
     "type": "git",
-    "url": "git+https://github.com/TypedProject/ts-log-debug.git"
+    "url": "git+https://github.com/TypedProject/logger.git"
   },
@@ -25,5 +25,5 @@ "keywords": [
   "bugs": {
-    "url": "https://github.com/TypedProject/ts-log-debug/issues"
+    "url": "https://github.com/TypedProject/logger/issues"
   },
-  "homepage": "https://github.com/TypedProject/ts-log-debug/packages/logger",
+  "homepage": "https://github.com/TypedProject/logger/packages/logger",
   "scripts": {
@@ -30,0 +30,0 @@ "build": "tsc --build tsconfig.compile.json",

readme.md

 # @tsed/logger 
 
-[![Build Status](https://travis-ci.org/TypedProject/ts-log-debug.svg?branch=master)](https://travis-ci.org/TypedProject/ts-log-debug)
-[![Coverage Status](https://coveralls.io/repos/github/TypedProject/ts-log-debug/badge.svg?branch=master)](https://coveralls.io/github/TypedProject/ts-log-debug?branch=master)
+[![Build Status](https://travis-ci.org/TypedProject/logger.svg?branch=master)](https://travis-ci.org/TypedProject/logger)
+[![Coverage Status](https://coveralls.io/repos/github/TypedProject/logger/badge.svg?branch=master)](https://coveralls.io/github/TypedProject/logger?branch=master)
 [![TypeScript](https://badges.frapsoft.com/typescript/love/typescript.svg?v=100)](https://github.com/ellerbrock/typescript-badges/) 
-[![Package Quality](http://npm.packagequality.com/shield/ts-log-debug.png)](http://packagequality.com/#?package=ts-log-debug)
-[![npm version](https://badge.fury.io/js/ts-log-debug.svg)](https://badge.fury.io/js/ts-log-debug)
-[![Dependencies](https://david-dm.org/TypedProject/ts-log-debug.svg)](https://david-dm.org/TypedProject/ts-log-debug#info=dependencies)
-[![img](https://david-dm.org/TypedProject/ts-log-debug/dev-status.svg)](https://david-dm.org/TypedProject/ts-log-debug/#info=devDependencies)
-[![img](https://david-dm.org/TypedProject/ts-log-debug/peer-status.svg)](https://david-dm.org/TypedProject/ts-log-debug/#info=peerDependenciess)
-[![Known Vulnerabilities](https://snyk.io/test/github/TypedProject/ts-log-debug/badge.svg)](https://snyk.io/test/github/TypedProject/ts-express-decorators)
+[![Package Quality](http://npm.packagequality.com/shield/logger.png)](http://packagequality.com/#?package=ts-log-debug)
+[![npm version](https://badge.fury.io/js/logger.svg)](https://badge.fury.io/js/logger)
+[![Dependencies](https://david-dm.org/TypedProject/logger.svg)](https://david-dm.org/TypedProject/logger#info=dependencies)
+[![img](https://david-dm.org/TypedProject/logger/dev-status.svg)](https://david-dm.org/TypedProject/logger/#info=devDependencies)
+[![img](https://david-dm.org/TypedProject/logger/peer-status.svg)](https://david-dm.org/TypedProject/logger/#info=peerDependenciess)
+[![Known Vulnerabilities](https://snyk.io/test/github/TypedProject/logger/badge.svg)](https://snyk.io/test/github/TypedProject/ts-express-decorators)
 
@@ -22,3 +22,3 @@ > A multi channel logger written in TypeScript.
 
-Please refer to the [documentation](https://typedproject.github.io/ts-log-debug/) for more details.
+Please refer to the [documentation](https://typedproject.github.io/logger/) for more details.
 
@@ -81,9 +81,2 @@ ## Installation
 
-
-## Contributors
-Please read [contributing guidelines here](https://tsed.io/CONTRIBUTING.html)
-
-<a href="https://github.com/TypedProject/ts-express-decorators/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
-
-
 ## Backers
@@ -90,0 +83,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

189981

increased by1%

Lines of code

3022

increased by2.58%

Worsened metrics

Number of lines in readme file

102

decreased by-6.42%

No dependency changes