jaid-logger/index.d.ts

Creates an opinionated Winston logger with advanced file system output.

/** @module jaid-logger
 */
declare module "jaid-logger" {
    /**
     * @typedef {Object} JaidLogger
     * @prop {string} appFolder
     * @prop {string} logFolder
     * @prop {Function} log
     * @prop {Function} info
     * @prop {Function} warn
     * @prop {Function} error
     * @prop {Function} debug
     */
    export type JaidLogger = {
        appFolder: string;
        logFolder: string;
        log: (...params: any[]) => any;
        info: (...params: any[]) => any;
        warn: (...params: any[]) => any;
        error: (...params: any[]) => any;
        debug: (...params: any[]) => any;
    };
    /**
     * @param {string|string[]} name App name
     * @return {JaidLogger}
     */
    export default function(name: string | string[]): JaidLogger;
}