README.md

suf-log

Logging utility, some parts are experimental, if you are not me don't use this package.

Docs

• interfaces

  • LogStyle
  • LogMessage
  • LogTableInput

• loggers

  • LogS
  • LogSingle

• styler

  • styler

interfaces

LogStyle

/**
 * color/background/font-weight work in node and the browser, the other properties only work in the browser.
 */
type LogStyle = string | {
    /**node and browser support */
    background?: string;
    /**node and browser support */
    color?: string;
    /**browser only */
    padding?: string;
    /**browser only */
    margin?: string;
    /**browser only, set to inline-block by default. */
    display?: string;
    /**browser only */
    border?: string;
    /**browser only */
    'border-radius'?: string;
    /**browser only */
    'text-align'?: string;
    /**browser only */
    'text-shadow'?: string;
    /**browser only */
    'font-size'?: string;
    /** for bold text in node add the value 'bold' */
    'font-weight'?: 'bold' | 'normal' | 'bolder' | 'lighter' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900';
    [key: string]: string | undefined;
}

LogMessage

type LogMessage = {
    message: string;
    style?: LogStyle;
}

LogTableInput

type LogTableInput = (number | string | LogMessage)[][];

loggers

LogS

/**works in node and the browser.*/
function Log(...messages: (string | LogMessage)[]): void;
interface LogTableOptions {
    padding?: number;
    spacing?: number;
}
/**node only*/
function LogTable(table: LogTableInput, options?: LogTableOptions): void;
/**works in the browser and node. */
function LogS(styles: LogStyle[], ...messages: string[]): void;

LogSingle

/**Log a single message with an optional style, works in the browser and node. */
function LogSingle(message: string, style?: LogStyle): void;

styler

styler

/**
 * this function is not browser compatible*.
 * @example ```ts
 * console.log(styler('test', 'red'))
 * ```
 *
 * *you have to add the styles manually, use the Log function for browser compatibly.
 */
function styler(input: string, style?: LogStyle): string;

Generated with suf-cli

License

Copyright (c) 2020 Leonard Grosoli Licensed under the MIT license.