added unit testing, and started implementing unit tests...phew
This commit is contained in:
161
node_modules/logform/index.d.ts
generated
vendored
Normal file
161
node_modules/logform/index.d.ts
generated
vendored
Normal file
@ -0,0 +1,161 @@
|
||||
// Type definitions for logform 1.2
|
||||
// Project: https://github.com/winstonjs/logform
|
||||
// Definitions by: DABH <https://github.com/DABH>
|
||||
// Definitions: https://github.com/winstonjs/logform
|
||||
// TypeScript Version: 2.2
|
||||
|
||||
export interface TransformableInfo {
|
||||
level: string;
|
||||
message: string;
|
||||
[key: string]: any;
|
||||
}
|
||||
|
||||
export type TransformFunction = (info: TransformableInfo, opts?: any) => TransformableInfo | boolean;
|
||||
export type Colors = { [key: string]: string | string[] }; // tslint:disable-line interface-over-type-literal
|
||||
export type FormatWrap = (opts?: any) => Format;
|
||||
|
||||
export class Format {
|
||||
constructor(opts?: object);
|
||||
|
||||
options?: object;
|
||||
transform: TransformFunction;
|
||||
}
|
||||
|
||||
export class Colorizer extends Format {
|
||||
constructor(opts?: object);
|
||||
|
||||
createColorize: (opts?: object) => Colorizer;
|
||||
addColors: (colors: Colors) => Colors;
|
||||
colorize: (level: string, message: string) => string;
|
||||
}
|
||||
|
||||
export function format(transform: TransformFunction): FormatWrap;
|
||||
|
||||
export function levels(config: object): object;
|
||||
|
||||
export namespace format {
|
||||
function align(): Format;
|
||||
function cli(opts?: CliOptions): Format;
|
||||
function colorize(opts?: ColorizeOptions): Colorizer;
|
||||
function combine(...formats: Format[]): Format;
|
||||
function errors(opts?: object): Format;
|
||||
function json(opts?: JsonOptions): Format;
|
||||
function label(opts?: LabelOptions): Format;
|
||||
function logstash(): Format;
|
||||
function metadata(opts?: MetadataOptions): Format;
|
||||
function ms(): Format;
|
||||
function padLevels(opts?: PadLevelsOptions): Format;
|
||||
function prettyPrint(opts?: PrettyPrintOptions): Format;
|
||||
function printf(templateFunction: (info: TransformableInfo) => string): Format;
|
||||
function simple(): Format;
|
||||
function splat(): Format;
|
||||
function timestamp(opts?: TimestampOptions): Format;
|
||||
function uncolorize(opts?: UncolorizeOptions): Format;
|
||||
}
|
||||
|
||||
export interface CliOptions extends ColorizeOptions, PadLevelsOptions {}
|
||||
|
||||
export interface ColorizeOptions {
|
||||
/**
|
||||
* If set to `true` the color will be applied to the `level`.
|
||||
*/
|
||||
level?: boolean;
|
||||
/**
|
||||
* If set to `true` the color will be applied to the `message` and `level`.
|
||||
*/
|
||||
all?: boolean;
|
||||
/**
|
||||
* If set to `true` the color will be applied to the `message`.
|
||||
*/
|
||||
message?: boolean;
|
||||
/**
|
||||
* An object containing the colors for the log levels. For example: `{ info: 'blue', error: 'red' }`.
|
||||
*/
|
||||
colors?: Record<string, string>;
|
||||
}
|
||||
|
||||
export interface JsonOptions {
|
||||
/**
|
||||
* A function that influences how the `info` is stringified.
|
||||
*/
|
||||
replacer?: (this: any, key: string, value: any) => any;
|
||||
/**
|
||||
* The number of white space used to format the json.
|
||||
*/
|
||||
space?: number;
|
||||
}
|
||||
|
||||
export interface LabelOptions {
|
||||
/**
|
||||
* A label to be added before the message.
|
||||
*/
|
||||
label?: string;
|
||||
/**
|
||||
* If set to `true` the `label` will be added to `info.message`. If set to `false` the `label`
|
||||
* will be added as `info.label`.
|
||||
*/
|
||||
message?: boolean;
|
||||
}
|
||||
|
||||
export interface MetadataOptions {
|
||||
/**
|
||||
* The name of the key used for the metadata object. Defaults to `metadata`.
|
||||
*/
|
||||
key?: string;
|
||||
/**
|
||||
* An array of keys that should not be added to the metadata object.
|
||||
*/
|
||||
fillExcept?: string[];
|
||||
/**
|
||||
* An array of keys that will be added to the metadata object.
|
||||
*/
|
||||
fillWith?: string[];
|
||||
}
|
||||
|
||||
export interface PadLevelsOptions {
|
||||
/**
|
||||
* Log levels. Defaults to `configs.npm.levels` from [triple-beam](https://github.com/winstonjs/triple-beam)
|
||||
* module.
|
||||
*/
|
||||
levels?: Record<string, number>;
|
||||
}
|
||||
|
||||
export interface PrettyPrintOptions {
|
||||
/**
|
||||
* A `number` that specifies the maximum depth of the `info` object being stringified by
|
||||
* `util.inspect`. Defaults to `2`.
|
||||
*/
|
||||
depth?: number;
|
||||
/**
|
||||
* Colorizes the message if set to `true`. Defaults to `false`.
|
||||
*/
|
||||
colorize?: boolean;
|
||||
}
|
||||
|
||||
export interface TimestampOptions {
|
||||
/**
|
||||
* Either the format as a string accepted by the [fecha](https://github.com/taylorhakes/fecha)
|
||||
* module or a function that returns a formatted date. If no format is provided `new
|
||||
* Date().toISOString()` will be used.
|
||||
*/
|
||||
format?: string;
|
||||
/**
|
||||
* The name of an alias for the timestamp property, that will be added to the `info` object.
|
||||
*/
|
||||
alias?: string;
|
||||
}
|
||||
|
||||
export interface UncolorizeOptions {
|
||||
/**
|
||||
* Disables the uncolorize format for `info.level` if set to `false`.
|
||||
*/
|
||||
level?: boolean;
|
||||
/**
|
||||
* Disables the uncolorize format for `info.message` if set to `false`.
|
||||
*/
|
||||
message?: boolean;
|
||||
/**
|
||||
* Disables the uncolorize format for `info[MESSAGE]` if set to `false`.
|
||||
*/
|
||||
raw?: boolean;
|
||||
}
|
Reference in New Issue
Block a user