mirror of
https://github.com/chenasraf/DefinitelyTyped.git
synced 2026-05-18 01:49:01 +00:00
7f4c8f472f
* Adding some optional constructor parameters * Update major * tiny update trying to get GitHub actions to run again to get rid of the "Where is GitHub actions?" tag that is blocking auto-merge
123 lines
3.6 KiB
TypeScript
123 lines
3.6 KiB
TypeScript
// Type definitions for lambda-log 3.0
|
|
// Project: https://github.com/KyleRoss/node-lambda-log
|
|
// Definitions by: Andrés Reyes Monge <https://github.com/armonge>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.8
|
|
/// <reference types="node" />
|
|
|
|
import { WriteStream } from "fs";
|
|
import { Console } from "console";
|
|
import { EventEmitter } from "events";
|
|
|
|
export interface LogRecordOptions {
|
|
level: string;
|
|
msg: string;
|
|
meta?: any;
|
|
tags?: string[] | undefined;
|
|
}
|
|
|
|
export interface LogRecord {
|
|
msg: string;
|
|
meta: any;
|
|
_logLevel: string;
|
|
_tags: string[];
|
|
}
|
|
|
|
export class LogMessage {
|
|
level: string;
|
|
msg: string;
|
|
|
|
meta?: any;
|
|
tags?: string[] | undefined;
|
|
|
|
constructor(logRecordOptions: LogRecordOptions, opts: LambdaLogOptions);
|
|
|
|
value: LogRecord;
|
|
log: LogRecord;
|
|
throw: undefined;
|
|
|
|
toJSON(format?: boolean): string;
|
|
|
|
static isError(val: any): boolean;
|
|
}
|
|
|
|
export interface LambdaLogOptions {
|
|
meta?: any;
|
|
// Global tags array to include with every log
|
|
tags?: string[] | undefined;
|
|
// Optional function which will run for every log to inject dynamic metadata
|
|
dynamicMeta?: ((message: LogMessage) => any) | undefined;
|
|
// Enable debugging mode (log.debug messages)
|
|
debug?: boolean | undefined;
|
|
// Enable development mode which pretty-prints the log object to the console
|
|
dev?: boolean | undefined;
|
|
// Disables logging to the console (used for testing)
|
|
silent?: boolean | undefined;
|
|
// Optional replacer function for `JSON.stringify`
|
|
replacer?: ((key: string, value: any) => any) | undefined;
|
|
// Console-like object containing all standard console functions. Allows logs to be written to any custom location. Default is console.
|
|
logHandler?: Console;
|
|
// Override the key in the JSON log message for the message. Default is "msg".
|
|
levelKey?: string | null;
|
|
// Override the key in the JSON log message for the message. Default is "msg".
|
|
messageKey?: string;
|
|
// Override the key in the JSON log message for the tags. Set to null to remove this key from the JSON output. Default is '_tags'.
|
|
tagsKey?: string | null;
|
|
}
|
|
|
|
export interface LogLevels {
|
|
info: "info";
|
|
warn: "warn";
|
|
error: "error";
|
|
debug: "log" | false;
|
|
[key: string]: any;
|
|
}
|
|
|
|
export class LambdaLog extends EventEmitter {
|
|
LambdaLog: LambdaLog;
|
|
options: LambdaLogOptions;
|
|
console: Console;
|
|
|
|
private _logLevels;
|
|
private _levels;
|
|
|
|
[key: string]: any;
|
|
|
|
constructor(options?: LambdaLogOptions, levels?: any);
|
|
|
|
log(level: string, msg: string, meta?: object, tags?: string[]): LogMessage;
|
|
info(msg: string, meta?: object, tags?: string[]): LogMessage;
|
|
warn(msg: string, meta?: object, tags?: string[]): LogMessage;
|
|
error(msg: string | Error, meta?: object, tags?: string[]): LogMessage;
|
|
debug(msg: string, meta?: object, tags?: string[]): LogMessage;
|
|
|
|
assert(
|
|
test: any,
|
|
msg: string,
|
|
meta?: object,
|
|
tags?: string[]
|
|
): boolean | LogMessage;
|
|
}
|
|
|
|
export function log(
|
|
level: string,
|
|
msg: string,
|
|
meta?: object,
|
|
tags?: string[]
|
|
): LogMessage;
|
|
export function info(msg: string, meta?: object, tags?: string[]): LogMessage;
|
|
export function warn(msg: string, meta?: object, tags?: string[]): LogMessage;
|
|
export function error(
|
|
msg: string | Error,
|
|
meta?: object,
|
|
tags?: string[]
|
|
): LogMessage;
|
|
export function assert(
|
|
test: any,
|
|
msg: string,
|
|
meta?: object,
|
|
tags?: string[]
|
|
): LogMessage;
|
|
export function debug(msg: string, meta?: object, tags?: string[]): LogMessage;
|
|
export const options: LambdaLogOptions;
|