roarr - npm Package Compare versions

Comparing version 3.3.0 to 4.0.0

dist/factories/createLogger.d.ts

@@ -1,3 +0,3 @@
-import type { Logger, MessageContextType, MessageEventHandlerType } from '../types';
-declare const createLogger: (onMessage: MessageEventHandlerType, parentContext?: MessageContextType) => Logger;
+import type { Logger, MessageContext, MessageEventHandler } from '../types';
+declare const createLogger: (onMessage: MessageEventHandler, parentContext?: MessageContext) => Logger;
 export default createLogger;

dist/factories/createMockLogger.d.ts

@@ -1,3 +0,3 @@
-import type { Logger, MessageContextType, MessageEventHandlerType } from '../types';
-declare const createMockLogger: (onMessage: MessageEventHandlerType, parentContext?: MessageContextType) => Logger;
+import type { Logger, MessageContext, MessageEventHandler } from '../types';
+declare const createMockLogger: (onMessage: MessageEventHandler, parentContext?: MessageContext) => Logger;
 export default createMockLogger;

dist/factories/createNodeWriter.d.ts

@@ -1,3 +0,3 @@
-import type { WriterType } from '../types';
-declare const _default: () => WriterType;
+import type { Writer } from '../types';
+declare const _default: () => Writer;
 export default _default;

dist/factories/createRoarrInitialGlobalState.d.ts

@@ -1,3 +0,3 @@
-import type { RoarrGlobalStateType } from '../types';
-declare const _default: (currentState: any) => RoarrGlobalStateType;
+import type { RoarrGlobalState } from '../types';
+declare const _default: (currentState: any) => RoarrGlobalState;
 export default _default;

dist/log.d.ts

@@ -1,6 +0,6 @@
-import type { RoarrGlobalStateType } from './types';
-declare const ROARR: RoarrGlobalStateType;
-export type { Logger, MessageType, TranslateMessageFunctionType, } from './types';
+import type { RoarrGlobalState } from './types';
+declare const ROARR: RoarrGlobalState;
+export type { Logger, Message, TranslateMessageFunction, MessageEventHandler, } from './types';
 export { ROARR, };
 declare const _default: import("./types").Logger;
 export default _default;

dist/types.d.ts

@@ -1,12 +0,12 @@
-export interface WriterType {
+export interface Writer {
     write: (message: string) => void;
 }
-export interface RoarrGlobalStateType extends WriterType {
+export interface RoarrGlobalState extends Writer {
     sequence: number;
     versions: ReadonlyArray<string>;
 }
-export declare type SprintfArgumentType = string | number | boolean | null;
-export declare type MessageContextType = any;
-export declare type MessageType = {
-    readonly context: MessageContextType;
+export declare type SprintfArgument = string | number | boolean | null;
+export declare type MessageContext = any;
+export declare type Message = {
+    readonly context: MessageContext;
     readonly message: string;
@@ -17,14 +17,14 @@ readonly sequence: number;
 };
-export declare type TranslateMessageFunctionType = (message: MessageType) => MessageType;
+export declare type TranslateMessageFunction = (message: Message) => Message;
 export declare type LogMethod = {
-    (context: MessageContextType, message: string, c?: SprintfArgumentType, d?: SprintfArgumentType, e?: SprintfArgumentType, f?: SprintfArgumentType, g?: SprintfArgumentType, h?: SprintfArgumentType, i?: SprintfArgumentType, j?: SprintfArgumentType): void;
-    (message: string, b?: SprintfArgumentType, c?: SprintfArgumentType, d?: SprintfArgumentType, e?: SprintfArgumentType, f?: SprintfArgumentType, g?: SprintfArgumentType, h?: SprintfArgumentType, i?: SprintfArgumentType, j?: SprintfArgumentType): void;
+    (context: MessageContext, message: string, c?: SprintfArgument, d?: SprintfArgument, e?: SprintfArgument, f?: SprintfArgument, g?: SprintfArgument, h?: SprintfArgument, i?: SprintfArgument, j?: SprintfArgument): void;
+    (message: string, b?: SprintfArgument, c?: SprintfArgument, d?: SprintfArgument, e?: SprintfArgument, f?: SprintfArgument, g?: SprintfArgument, h?: SprintfArgument, i?: SprintfArgument, j?: SprintfArgument): void;
 };
 export interface Logger extends LogMethod {
-    adopt: <T>(routine: () => Promise<T>, context: MessageContextType) => Promise<T>;
-    child: (context: TranslateMessageFunctionType | MessageContextType) => Logger;
+    adopt: <T>(routine: () => Promise<T>, context: MessageContext) => Promise<T>;
+    child: (context: TranslateMessageFunction | MessageContext) => Logger;
     debug: LogMethod;
     error: LogMethod;
     fatal: LogMethod;
-    getContext: () => MessageContextType;
+    getContext: () => MessageContext;
     info: LogMethod;
@@ -34,2 +34,2 @@ trace: LogMethod;
 }
-export declare type MessageEventHandlerType = (message: MessageType) => void;
+export declare type MessageEventHandler = (message: Message) => void;

package.json

@@ -81,3 +81,3 @@ {
   "typings": "./dist/log.d.ts",
-  "version": "3.3.0"
+  "version": "4.0.0"
 }

README.md

@@ -225,26 +225,26 @@ <a name="roarr"></a>
 ```js
-export type LoggerType =
+export type Logger =
   (
-    context: MessageContextType,
+    context: MessageContext,
     message: string,
-    c?: SprintfArgumentType,
-    d?: SprintfArgumentType,
-    e?: SprintfArgumentType,
-    f?: SprintfArgumentType,
-    g?: SprintfArgumentType,
-    h?: SprintfArgumentType,
-    i?: SprintfArgumentType,
-    k?: SprintfArgumentType
+    c?: SprintfArgument,
+    d?: SprintfArgument,
+    e?: SprintfArgument,
+    f?: SprintfArgument,
+    g?: SprintfArgument,
+    h?: SprintfArgument,
+    i?: SprintfArgument,
+    k?: SprintfArgument
   ) => void |
   (
     message: string,
-    b?: SprintfArgumentType,
-    c?: SprintfArgumentType,
-    d?: SprintfArgumentType,
-    e?: SprintfArgumentType,
-    f?: SprintfArgumentType,
-    g?: SprintfArgumentType,
-    h?: SprintfArgumentType,
-    i?: SprintfArgumentType,
-    k?: SprintfArgumentType
+    b?: SprintfArgument,
+    c?: SprintfArgument,
+    d?: SprintfArgument,
+    e?: SprintfArgument,
+    f?: SprintfArgument,
+    g?: SprintfArgument,
+    h?: SprintfArgument,
+    i?: SprintfArgument,
+    k?: SprintfArgument
   ) => void;
@@ -268,3 +268,3 @@
 ```js
-<T>(routine: () => Promise<T>, context: MessageContextType) => Promise<T>,
+<T>(routine: () => Promise<T>, context: MessageContext) => Promise<T>,
 
@@ -311,3 +311,3 @@ ```
 ```js
-(context: TranslateMessageFunctionType | MessageContextType) => LoggerType,
+(context: TranslateMessageFunction | MessageContext) => Logger,
 
@@ -325,3 +325,3 @@ ```
 ```js
-(context: MessageContextType) => LoggerType;
+(context: MessageContext) => Logger;
 
@@ -355,3 +355,3 @@ ```
 ```js
-(translateMessage: TranslateMessageFunctionType) => LoggerType;
+(translateMessage: TranslateMessageFunction) => Logger;
 
@@ -506,3 +506,3 @@ ```
 
-|Name|Type|Function|Default|
+|Name||Function|Default|
 |---|---|---|---|
@@ -509,0 +509,0 @@ |`ROARR_LOG`|Boolean|Enables/ disables logging.|`false`|

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

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

Worsened metrics

Total package byte prevSize

40546

decreased by-0.71%

No dependency changes