DefinitelyTyped/types/lambda-log/index.d.ts

// Type definitions for lambda-log 2.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 LambdaLogOptions {
    meta?: any;
    // Global tags array to include with every log
    tags?: string[];
    // Optional function which will run for every log to inject dynamic metadata
    dynamicMeta?: null;
    // Enable debugging mode (log.debug messages)
    debug?: boolean;
    // Enable development mode which pretty-prints the log object to the console
    dev?: boolean;
    // Disables logging to the console (used for testing)
    silent?: boolean;
    // Optional replacer function for `JSON.stringify`
    replacer?: (key: string, value: any) => any;
    // Optional stream to write stdout messages to
    stdoutStream?: WriteStream;
    // Optional stream to write stderr messages to
    stderrStream?: WriteStream;
}

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[]): string;

    assert(test: any, msg: string, meta: object, tags: string[]): boolean | string;
}