discord-winston-transport/build/index.d.ts

Discord Winston Transport for sending logs to Discord

import Transport, { TransportStreamOptions } from 'winston-transport';
import { TransformableInfo } from 'logform';
/**
 * Options for Discord transport for winston
 */
export interface DiscordTransportOptions extends TransportStreamOptions {
    /** Webhook obtained from Discord */
    webhook: string;
    /** Meta data to be included inside Discord Message */
    defaultMeta?: Record<string, string>;
}
/**
 * Discord log info interface
 */
interface DiscordLogInfo extends TransformableInfo {
    error?: Error;
    meta?: Record<string, string>;
    discord?: boolean;
}
/**
 * Discord Transport for winston
 */
export default class DiscordTransport extends Transport {
    /** Webhook obtained from Discord */
    private webhook;
    /** Discord webhook id */
    private id?;
    /** Discord webhook token */
    private token?;
    /** Initialization promise resolved after retrieving discord id and token */
    private initialized;
    /** Meta data to be included inside Discord Message */
    private defaultMeta;
    /** Available colors for discord messages */
    private static COLORS;
    constructor(opts: DiscordTransportOptions);
    /** Helper function to retrieve url */
    private getUrl;
    /**
     * Initialize the transport to fetch Discord id and token
     */
    private initialize;
    /**
     * Function exposed to winston to be called when logging messages
     * @param info Log message from winston
     * @param callback Callback to winston to complete the log
     */
    log(info: DiscordLogInfo, callback: () => void): void;
    /**
     * Sends log message to discord
     */
    private sendToDiscord;
}
export { DiscordTransport };