@types/text-table/index.d.ts

TypeScript definitions for text-table

/**
 * Generates borderless text table strings suitable for printing to stdout.
 */
declare function table(
    /** An array of arrays containing strings, numbers, or other printable values. */
    rows: Array<Array<{}>>,
    /** A configuration object to customize table output. */
    options?: table.Options,
): string;

declare namespace table {
    interface Options {
        /** Separator to use between columns, (default: ' '). */
        hsep?: string | undefined;

        /** An array of alignment types for each column, default ['l','l',...]. */
        align?: Array<"l" | "r" | "c" | "." | null | undefined> | undefined;

        /** A callback function to use when calculating the string length. */
        stringLength?(str: string): number;
    }
}

export = table;