Skip to content

Commit

Permalink
fix: add missing def files
Browse files Browse the repository at this point in the history
  • Loading branch information
christophehurpeau committed Dec 12, 2020
1 parent 9f5491b commit a6c0b82
Show file tree
Hide file tree
Showing 16 changed files with 291 additions and 0 deletions.
9 changes: 9 additions & 0 deletions packages/nightingale-formatter/dist/formatObject.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import type { Styles } from 'nightingale-types';
export interface FormatObjectOptions {
padding?: string;
maxDepth?: number;
}
export declare type StyleFn = (styles: Styles, value: string) => string;
export declare type ObjectStyles<Keys extends string = string> = Record<Keys, Styles>;
export default function formatObject(object: Record<string, unknown>, styleFn?: StyleFn, objectStyles?: ObjectStyles, { padding, maxDepth }?: FormatObjectOptions): string;
//# sourceMappingURL=formatObject.d.ts.map
1 change: 1 addition & 0 deletions packages/nightingale-formatter/dist/formatObject.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions packages/nightingale-formatter/dist/formatRecordToString.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import type { LogRecord, Metadata } from 'nightingale-types';
import type { StyleFn } from './formatObject';
export default function formatRecordToString<T extends Metadata>(record: LogRecord<T>, style: StyleFn): string;
//# sourceMappingURL=formatRecordToString.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions packages/nightingale-formatter/dist/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export { default as levelToStyles } from './levelToStyles';
export { default as levelToSymbol } from './levelToSymbol';
export { default as styleToHtmlStyle } from './styleToHtmlStyle';
export { default as styleToHexColor } from './styleToHexColor';
export { default as formatObject } from './formatObject';
export { default as formatRecordToString } from './formatRecordToString';
//# sourceMappingURL=index.d.ts.map
1 change: 1 addition & 0 deletions packages/nightingale-formatter/dist/index.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions packages/nightingale-formatter/dist/levelToStyles.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export interface LevelToStyles {
readonly [level: number]: string[];
}
declare const levelToStyles: LevelToStyles;
export default levelToStyles;
//# sourceMappingURL=levelToStyles.d.ts.map
1 change: 1 addition & 0 deletions packages/nightingale-formatter/dist/levelToStyles.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions packages/nightingale-formatter/dist/levelToSymbol.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export interface LevelToSymbol {
readonly [level: number]: string;
}
declare const levelToSymbol: LevelToSymbol;
export default levelToSymbol;
//# sourceMappingURL=levelToSymbol.d.ts.map
1 change: 1 addition & 0 deletions packages/nightingale-formatter/dist/levelToSymbol.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions packages/nightingale-formatter/dist/styleToHexColor.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export interface StyleToHexColor {
readonly [key: string]: string;
}
declare const styleToHexColor: StyleToHexColor;
export default styleToHexColor;
//# sourceMappingURL=styleToHexColor.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions packages/nightingale-formatter/dist/styleToHtmlStyle.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
export interface HtmlStyle {
readonly open: string;
readonly close: string;
}
export interface StyleToHtmlStyle {
readonly [key: string]: HtmlStyle;
}
declare const styleToHtmlStyle: StyleToHtmlStyle;
export default styleToHtmlStyle;
//# sourceMappingURL=styleToHtmlStyle.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

235 changes: 235 additions & 0 deletions packages/nightingale-logger/dist/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,235 @@
import Level from 'nightingale-levels';
import type { Metadata, MetadataStyles, Styles, Handler, Processor, LogRecord } from 'nightingale-types';
export { Level };
export interface Options<T extends Metadata> {
symbol?: string;
metadataStyles?: MetadataStyles<T>;
styles?: Styles;
}
export interface ComputedConfigForKey {
handlers: Handler[];
processors: Processor[];
}
interface ExtendedFunctionNameMetadata {
functionName: string;
}
export interface Config {
handler?: Handler;
handlers?: Handler[];
key?: string;
keys?: string[];
pattern?: RegExp;
processor?: Processor;
processors?: Processor[];
stop?: boolean;
}
declare global {
namespace NodeJS {
interface Global {
__NIGHTINGALE_CONFIG: Config[];
__NIGHTINGALE_LOGGER_MAP_CACHE: Map<string, ComputedConfigForKey>;
__NIGHTINGALE_CONFIG_DEFAULT: ComputedConfigForKey;
__NIGHTINGALE_GLOBAL_HANDLERS: unknown;
__NIGHTINGALE_GET_CONFIG_FOR_LOGGER: (key: string) => ComputedConfigForKey;
__NIGHTINGALE_GET_CONFIG_FOR_LOGGER_RECORD: (key: string, level: number) => ComputedConfigForKey;
}
}
}
/**
* Interface that allows you to log records.
* This records are treated by handlers
*/
export default class Logger {
private contextObject?;
readonly key: string;
readonly displayName?: string;
/**
* Create a new Logger
*
* @param {string} key
* @param {string} [displayName]
*/
constructor(key: string, displayName?: string);
/** @private */
protected getHandlersAndProcessors(recordLevel: number): ComputedConfigForKey;
/** @private */
getConfig(): Readonly<ComputedConfigForKey>;
/**
* Create a child logger
*/
child(childSuffixKey: string, childDisplayName?: string): Logger;
/**
* Create a new Logger with the same key a this attached context
*
* @example
* const loggerMyService = new Logger('app.myService');
* function someAction(arg1) {
* const logger = loggerMyService.context({ arg1 });
* logger.info('starting');
* // do stuff
* logger.info('done');
* }
*
*/
context(context: Record<string, unknown>): Logger;
/**
* Get the context of this logger
*/
getContextObject(): Readonly<Record<string, unknown>> | undefined;
/**
* Set the context of this logger
*
* @param {Object} context
*/
setContext(context: Record<string, unknown>): void;
/**
* Extends existing context of this logger
*/
extendsContext(extendedContext: Record<string, unknown>): void;
/**
* Handle a record
*
* Use this only if you know what you are doing.
*/
addRecord<T extends Metadata>(record: Readonly<LogRecord<T>>): void;
/**
* Log a message
*/
log<T extends Metadata>(message: string, metadata?: T, level?: Level, options?: Options<T>): void;
/**
* Log a trace message
*/
trace<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log a debug message
*/
debug<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Notice an info message
*/
notice<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log an info message
*/
info<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log a warn message
*/
warn<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log an error message
*/
error<T extends Metadata>(message: string | Error, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log an critical message
*/
critical<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log a fatal message
*/
fatal<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log an alert message
*/
alert<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log an inspected value
*/
inspectValue<T extends Metadata>(value: unknown, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log a debugged var
*/
inspectVar<T extends Metadata>(varName: string, varValue: unknown, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Alias for infoSuccess
*/
success<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log an info success message
*/
infoSuccess<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log an debug success message
*/
debugSuccess<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Alias for infoFail
*/
fail<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log an info fail message
*/
infoFail<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log an debug fail message
*/
debugFail<T extends Metadata>(message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* @returns {number} time to pass to timeEnd
*/
time<T extends Metadata>(message?: string, metadata?: T, metadataStyles?: MetadataStyles<T>, level?: number): number;
infoTime<T extends Metadata>(message?: string, metadata?: T, metadataStyles?: MetadataStyles<T>): number;
/**
* Finds difference between when this method
* was called and when the respective time method
* was called, then logs out the difference
* and deletes the original record
*/
timeEnd<T extends Metadata>(startTime: number, message: string, metadata?: T, metadataStyles?: MetadataStyles<T>, level?: number, options?: Options<T>): void;
/**
* Like timeEnd, but with INFO level
*/
infoTimeEnd<T extends Metadata>(time: number, message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Like timeEnd, but with INFO level
*/
infoSuccessTimeEnd<T extends Metadata>(time: number, message: string, metadata?: T, metadataStyles?: MetadataStyles<T>): void;
/**
* Log an enter in a function
*
* @example
* class A {
* method(arg1) {
* logger.enter(method, { arg1 });
* // Do your stuff
* }
* }
*
*/
enter<T extends Metadata, Fn extends (...args: unknown[]) => unknown>(fn: Fn, metadata?: T, metadataStyles?: MetadataStyles<T & ExtendedFunctionNameMetadata>): void;
/**
* Log an exit in a function
*
* @example
* const logger = new ConsoleLogger('myNamespace.A');
* class A {
* method(arg1) {
* // Do your stuff
* logger.exit(method, { arg1 });
* }
* }
*/
exit<T extends Metadata, Fn extends (...args: unknown[]) => unknown>(fn: Fn, metadata?: T, metadataStyles?: MetadataStyles<T & ExtendedFunctionNameMetadata>): void;
/**
* Wrap around a function to log enter and exit of a function
*
* @example
* const logger = new ConsoleLogger('myNamespace.A');
* class A {
* method() {
* logger.wrap(method, () => {
* // Do your stuff
* });
* }
* }
*
* @param {Function} fn
* @param {Object} [metadata]
* @param {Object} [metadataStyles]
* @param {Function} callback
*/
wrap<Fn extends (...args: unknown[]) => unknown>(fn: Fn, callback: () => void): void;
wrap<T extends Metadata, Fn extends (...args: unknown[]) => unknown>(fn: Fn, metadata: T, callback: () => void): void;
wrap<T extends Metadata, Fn extends (...args: unknown[]) => unknown>(fn: Fn, metadata: T, metadataStyles: MetadataStyles<T>, callback: () => void): void;
}
//# sourceMappingURL=index.d.ts.map
1 change: 1 addition & 0 deletions packages/nightingale-logger/dist/index.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a6c0b82

Please sign in to comment.