DefinitelyTyped/types/npmlog/index.d.ts

// Type definitions for npmlog 4.1
// Project: https://github.com/npm/npmlog#readme
// Definitions by: Daniel Schmidt <https://github.com/DanielMSchmidt>
//                 Zhu Zijia <https://github.com/littlepiggy03>
//                 Joseph Wynn <https://github.com/wildlyinaccurate>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.4

import { EventEmitter } from "events";

declare namespace npmlog {
    // TODO: newStream, newGroup, setGaugeTemplate and setGaugeTemplateSet need to be added
    interface Logger extends EventEmitter {
        (): any;

        level: string;
        record: MessageObject[];
        maxRecordSize: number;
        prefixStyle: StyleObject;
        headingStyle: StyleObject;
        heading: string;
        stream: any; // Defaults to process.stderr

        log(level: LogLevels | string, prefix: string, message: string, ...args: any[]): void;

        silly(prefix: string, message: string, ...args: any[]): void;
        verbose(prefix: string, message: string, ...args: any[]): void;
        info(prefix: string, message: string, ...args: any[]): void;
        timing(prefix: string, message: string, ...args: any[]): void;
        http(prefix: string, message: string, ...args: any[]): void;
        notice(prefix: string, message: string, ...args: any[]): void;
        warn(prefix: string, message: string, ...args: any[]): void;
        error(prefix: string, message: string, ...args: any[]): void;
        silent(prefix: string, message: string, ...args: any[]): void;

        enableColor(): void;
        disableColor(): void;

        enableProgress(): void;
        disableProgress(): void;
        progressEnabled(): boolean;

        enableUnicode(): void;
        disableUnicode(): void;

        pause(): void;
        resume(): void;

        addLevel(level: string, n: number, style?: StyleObject, disp?: string): void;

        // Allows for custom log levels
        // npmlog.addLevel("custom", level)
        // npmlog.custom(prefix, message)
        [key: string]: any;
    }

    type LogLevels = "silly" | "verbose" | "info" | "timing" | "http" | "notice" | "warn" | "error" | "silent";

    interface StyleObject {
        fg?: string;
        bg?: string;
        bold?: boolean;
        inverse?: boolean;
        underline?: boolean;
        bell?: boolean;
    }

    interface MessageObject {
        id: number;
        level: string;
        prefix: string;
        message: string;
        messageRaw: string;
    }
}

declare var npmlog: npmlog.Logger;
export = npmlog;