@niceties/logger
Advanced tools
Comparing version 1.1.10 to 1.1.11
import { Appender, LogMessage } from './types'; | ||
export declare const filterMessages: <ErrorContext = Error, Api extends object = object>(predicate: (logMessage: LogMessage<ErrorContext>) => boolean, appender: Appender<ErrorContext>, api?: Api | undefined) => Appender<ErrorContext> & Api; | ||
export declare const combineAppenders: <ErrorContext = Error>(...appenders: Appender<ErrorContext>[]) => Appender<ErrorContext>; |
import { Formatter, LogMessage } from './types'; | ||
export declare const createConsoleAppender: (formatter: Formatter) => (message: LogMessage) => void; |
import { Appender, LogLevel, LogMessage, Identity } from './types'; | ||
export declare const createLogger: <ErrorContext = Error>(...args: [ | ||
] | [string | Identity | undefined] | [string, Identity]) => ((message: string, loglevel?: LogLevel, context?: ErrorContext | undefined) => void) & { | ||
start(message: string, loglevel?: LogLevel | undefined, context?: ErrorContext | undefined): void; | ||
update(message: string, loglevel?: LogLevel | undefined, context?: ErrorContext | undefined): void; | ||
finish(message: string, loglevel?: LogLevel | undefined, context?: ErrorContext | undefined): void; | ||
start(message: string, loglevel?: LogLevel, context?: ErrorContext | undefined): void; | ||
update(message: string, loglevel?: LogLevel, context?: ErrorContext | undefined): void; | ||
finish(message: string, loglevel?: LogLevel, context?: ErrorContext | undefined): void; | ||
appender(appender?: Appender<ErrorContext> | undefined): (message: LogMessage<ErrorContext>) => void; | ||
} & Identity; |
@@ -1,2 +0,2 @@ | ||
!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports,require("./global-appender")):"function"==typeof define&&define.amd?define(["exports","./global-appender"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).nicetiesLoggerCore={},e.nicetiesLoggerGlobalAppender)}(this,(function(e,t){"use strict";let n=0;e.createLogger=(...e)=>{let o=1,i=e=>{t.globalAppender&&t.globalAppender(e)};const l=n++,{tag:d,parentId:a}=(e=>{var t,n;let o,i;return 1===e.length?"string"==typeof e[0]?i=e[0]:o=null===(t=e[0])||void 0===t?void 0:t.id:2===e.length&&(i=e[0],o=null===(n=e[1])||void 0===n?void 0:n.id),{parentId:o,tag:i}})(e),r=(e,t,n,o)=>{i&&i({action:t,inputId:l,message:e,loglevel:n,tag:d,parentId:a,ref:f,context:o})},p=Object.assign(((e,t=1,n)=>{r(e,3,t,n)}),{start(e,t,n){void 0!==t&&(o=t),r(e,0,o,n)},update(e,t,n){r(e,1,null!=t?t:o,n)},finish(e,t,n){r(e,2,null!=t?t:o,n)},appender:e=>(void 0!==e&&(i=e),i)});Object.defineProperty(p,"id",{value:l,writable:!1});const f=new WeakRef(p);return p}})); | ||
!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports,require("./global-appender")):"function"==typeof define&&define.amd?define(["exports","./global-appender"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).nicetiesLoggerCore={},e.nicetiesLoggerGlobalAppender)}(this,(function(e,t){"use strict";let n=0;e.createLogger=(...e)=>{let o=1,i=e=>{t.globalAppender&&t.globalAppender(e)};const a=n++,{tag:r,parentId:d}=(e=>{let t,n;return 1===e.length?"string"==typeof e[0]?n=e[0]:t=e[0]?.id:2===e.length&&(n=e[0],t=e[1]?.id),{parentId:t,tag:n}})(e),p=(e,t,n,o)=>{i&&i({action:t,inputId:a,message:e,loglevel:n,tag:r,parentId:d,ref:f,context:o})},l=Object.assign(((e,t=1,n)=>{p(e,3,t,n)}),{start(e,t,n){void 0!==t&&(o=t),p(e,0,o,n)},update(e,t,n){p(e,1,t??o,n)},finish(e,t,n){p(e,2,t??o,n)},appender:e=>(void 0!==e&&(i=e),i)});Object.defineProperty(l,"id",{value:a,writable:!1});const f=new WeakRef(l);return l}})); | ||
//# sourceMappingURL=core.umd.js.map |
@@ -0,0 +0,0 @@ import { ColorFormatters, Prefixes } from './types'; |
import { ColorFormatters, LogMessage, Prefixes } from './types'; | ||
export declare const createFormatter: (colors: ColorFormatters, prefixes: Prefixes, tagFactory: (tag: string) => string) => ({ loglevel, message, context, action, tag }: LogMessage, usePrefix?: string | boolean | undefined, identation?: number) => string; | ||
export declare const createFormatter: (colors: ColorFormatters, prefixes: Prefixes, tagFactory: (tag: string) => string) => ({ loglevel, message, context, action, tag }: LogMessage, usePrefix?: string | boolean, identation?: number) => string; | ||
export declare const terminalSupportsUnicode: () => boolean; |
import { Appender } from './types'; | ||
export declare let globalAppender: Appender<any>; | ||
export declare const appender: <ErrorContext = Error>(appender?: Appender<ErrorContext> | undefined) => Appender<any>; |
@@ -0,0 +0,0 @@ import { createLogger } from './core'; |
import { Appender, LogLevel, LogMessage } from './types'; | ||
export declare const createLogger: <ErrorContext = Error>(tag?: string | undefined) => ((message: string, loglevel?: LogLevel, context?: ErrorContext | undefined) => void) & { | ||
export declare const createLogger: <ErrorContext = Error>(tag?: string) => ((message: string, loglevel?: LogLevel, context?: ErrorContext | undefined) => void) & { | ||
appender(appender?: Appender<ErrorContext> | undefined): (message: LogMessage<ErrorContext>) => void; | ||
}; |
@@ -13,3 +13,3 @@ export declare const enum LogLevel { | ||
} | ||
export declare type LogMessage<ErrorContext = Error> = { | ||
export type LogMessage<ErrorContext = Error> = { | ||
inputId: number; | ||
@@ -33,14 +33,14 @@ loglevel: LogLevel; | ||
}; | ||
export declare type Appender<ErrorContext = Error> = (message: LogMessage<ErrorContext>) => void; | ||
export declare type Identity = { | ||
export type Appender<ErrorContext = Error> = (message: LogMessage<ErrorContext>) => void; | ||
export type Identity = { | ||
id?: number; | ||
}; | ||
export declare type Prefixes = { | ||
export type Prefixes = { | ||
[index in LogLevel]: string; | ||
}; | ||
export declare type ColorFormatters = { | ||
export type ColorFormatters = { | ||
[index in LogLevel]: (((text: string) => string) | undefined); | ||
}; | ||
export declare type Formatter<ErrorContext = Error> = (message: LogMessage<ErrorContext>, usePrefix?: string | boolean, identation?: number) => string; | ||
export declare type Logger<ErrorContext = Error> = ((message: string, loglevel?: LogLevel, context?: ErrorContext | undefined) => void) & { | ||
export type Formatter<ErrorContext = Error> = (message: LogMessage<ErrorContext>, usePrefix?: string | boolean, identation?: number) => string; | ||
export type Logger<ErrorContext = Error> = ((message: string, loglevel?: LogLevel, context?: ErrorContext | undefined) => void) & { | ||
start(message: string, loglevel?: LogLevel | undefined, context?: ErrorContext | undefined): void; | ||
@@ -51,4 +51,4 @@ update(message: string, loglevel?: LogLevel | undefined, context?: ErrorContext | undefined): void; | ||
} & Identity; | ||
export declare type MinLogLevelApi = { | ||
export type MinLogLevelApi = { | ||
setMinLevel(logLevel: LogLevel): void; | ||
}; |
{ | ||
"version": "1.1.10", | ||
"version": "1.1.11", | ||
"license": "MIT", | ||
@@ -75,31 +75,10 @@ "name": "@niceties/logger", | ||
], | ||
"dependencies": { | ||
"kleur": "^4.1.4" | ||
}, | ||
"scripts": { | ||
"build": "pkgbld-internal --umd=core,simple,console-appender,global-appender,appender-utils --preprocess=index", | ||
"test": "jest --collectCoverage", | ||
"lint": "eslint ./src", | ||
"semantic-release": "npx semantic-release" | ||
}, | ||
"devDependencies": { | ||
"@semantic-release/changelog": "6.0.1", | ||
"@semantic-release/commit-analyzer": "9.0.1", | ||
"@semantic-release/git": "10.0.1", | ||
"@semantic-release/npm": "8.0.2", | ||
"@semantic-release/release-notes-generator": "10.0.2", | ||
"@types/jest": "27.0.3", | ||
"@types/node": "17.0.5", | ||
"@typescript-eslint/eslint-plugin": "5.8.1", | ||
"@typescript-eslint/parser": "5.8.1", | ||
"conventional-changelog-angular": "5.0.13", | ||
"eslint": "8.5.0", | ||
"jest": "27.4.5", | ||
"semantic-release": "18.0.0", | ||
"semantic-release-monorepo": "7.0.5", | ||
"ts-jest": "27.1.2", | ||
"tslib": "2.3.1", | ||
"typescript": "4.6.x", | ||
"pkgbld-internal": "1.0.4" | ||
}, | ||
"dependencies": { | ||
"kleur": "^4.1.4" | ||
"lint": "eslint ./src" | ||
} | ||
} | ||
} |
@@ -9,3 +9,3 @@ # Logger | ||
- Provides default appender that uses console for output. | ||
- Provides a default appender that uses console for output. | ||
@@ -22,3 +22,3 @@ - Modular and configurable | ||
### [Changlelog](./CHANGELOG.md) | ||
### [Changelog](./CHANGELOG.md) | ||
@@ -95,3 +95,3 @@ # Example | ||
Emits start event inside a logger. If loglevel provided it will be remembered and used as default loglevel in subsequent events in the same logger instance. Default loglevel (if argument is not provided) is `info`. | ||
Emits a start event inside a logger. If loglevel provided it will be remembered and used as default loglevel in subsequent events in the same logger instance. Default loglevel (if argument is not provided) is `info`. | ||
@@ -102,3 +102,3 @@ ```typescript | ||
Emits update event. Can be used to inform user that we are doing something else in the same async task. loglevel used to redefine default loglevel. | ||
Emits update event. Can be used to inform an user that we are doing something else in the same async task. loglevel used to redefine default loglevel. | ||
@@ -109,3 +109,3 @@ ```typescript | ||
Emits finish event. Can be used to inform user that task finished. loglevel is optional and equals initial loglevel if omitted. | ||
Emits finish event. Can be used to inform an user that the task finished. loglevel is optional and equals initial loglevel if omitted. | ||
@@ -117,3 +117,3 @@ ```typescript | ||
Sets different appender for the specific instance of the logger. | ||
Sets a different appender for the specific instance of the logger. | ||
@@ -178,3 +178,3 @@ ```typescript | ||
Same appender function without arguments can be used to get current appender. | ||
Same appender function without arguments can be used to get the current appender. | ||
@@ -230,3 +230,3 @@ # FAQ | ||
Subpackage `'@niceties/logger/default-formatting'` exports formatting constants that is part of default configuration of the console appender. | ||
Subpackage `'@niceties/logger/default-formatting'` exports formatting constants that are part of default configuration of the console appender. | ||
@@ -245,3 +245,3 @@ Subpackage `'@niceties/logger/core'` exports `createLogger()` factory. | ||
`simple` (default), `core` and `console-appender` exists as umd packages as well but probably require some effort to consume them. | ||
`simple` (default), `core` and `console-appender` exist as umd packages as well but probably require some effort to consume them. | ||
@@ -258,2 +258,2 @@ # Prior art | ||
[MIT](./LICENSE) | ||
[MIT](https://github.com/kshutkin/niceties/blob/main/LICENSE) |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
0
47
459
32346