Node TAP
    Preparing search index...

    Interface Style

    A set of functions defining how various sorts of things get converted into strings.

    interface Style {
        arrayEmpty: (cls: string) => string;
        arrayEntrySep: () => string;
        arrayHead: (cls: string) => string;
        arrayTail: (indent: string) => string;
        bufferBody: (buf: Buffer) => string;
        bufferChunkSize: number;
        bufferEmpty: () => string;
        bufferEnd: (buf: Buffer) => string;
        bufferHead: () => string;
        bufferKey: (i: number) => string;
        bufferKeySep: () => string;
        bufferLine: (buf: Buffer, chunkSize: number) => string;
        bufferLineSep: () => string;
        bufferStart: () => string;
        bufferTail: (indent: string) => string;
        circular: (node: Format) => string;
        diffable: boolean;
        errorEmpty: (er: Error, cls: string) => string;
        errorHead: (
            er: (Error | { message?: string; name?: string }) & {
                generatedMessage?: string;
            },
            cls: string,
        ) => string;
        errorTail: (indent: string) => string;
        fn: (fn: Function | ((...a: any[]) => any), cls: string) => string;
        mapEmpty: (cls: string) => string;
        mapEntrySep: () => string;
        mapHead: (cls: string) => string;
        mapKeyStart: () => string;
        mapKeyValSep: () => string;
        mapTail: (indent: string) => string;
        nodeId: (id: number) => string;
        pojoEmpty: (cls: string) => string;
        pojoEntrySep: () => string;
        pojoHead: (cls: string) => string;
        pojoKeyValSep: () => string;
        pojoTail: (indent: string) => string;
        reactElement?: (node: ReactNode) => string;
        setEmpty: (cls: string) => string;
        setEntrySep: () => string;
        setHead: (cls: string) => string;
        setTail: (indent: string) => string;
        start: (indent: string, key: string, sep: string) => string;
        stringEmpty: () => string;
        stringHead: () => string;
        stringLine: (str: string) => string;
        stringLineSep: () => string;
        stringOneLine: (str: string) => string;
        stringTail: (indent: string) => string;
        symbol: (method: string, key: string) => string;
    }
    Index

    Properties

    arrayEmpty arrayEntrySep arrayHead arrayTail bufferBody bufferChunkSize bufferEmpty bufferEnd bufferHead bufferKey bufferKeySep bufferLine bufferLineSep bufferStart bufferTail circular diffable errorEmpty errorHead errorTail fn mapEmpty mapEntrySep mapHead mapKeyStart mapKeyValSep mapTail nodeId pojoEmpty pojoEntrySep pojoHead pojoKeyValSep pojoTail reactElement? setEmpty setEntrySep setHead setTail start stringEmpty stringHead stringLine stringLineSep stringOneLine stringTail symbol

    Properties

    arrayEmpty: (cls: string) => string

    an empty Array

    arrayEntrySep: () => string

    separator between entries in an Array

    arrayHead: (cls: string) => string

    start of an Array

    arrayTail: (indent: string) => string

    end of an Array

    bufferBody: (buf: Buffer) => string

    contents of a short Buffer

    bufferChunkSize: number

    how many bytes of a Buffer to show per line. can be overridden by the Format constructor options.

    bufferEmpty: () => string

    an empty Buffer

    bufferEnd: (buf: Buffer) => string

    end of a short Buffer

    bufferHead: () => string

    start of a long Buffer

    bufferKey: (i: number) => string

    line numbers to print for lines in a long Buffer

    bufferKeySep: () => string

    separator between line number and contents of a long Buffer

    bufferLine: (buf: Buffer, chunkSize: number) => string

    line of bytes in a long Buffer

    bufferLineSep: () => string

    separator between lines in a long Buffer

    bufferStart: () => string

    start of a short Buffer

    bufferTail: (indent: string) => string

    end of a long Buffer

    circular: (node: Format) => string

    what to print when we encounter a circular reference

    diffable: boolean

    indicator as to whether this style is suitable for use in diffs

    errorEmpty: (er: Error, cls: string) => string

    an empty Error object

    errorHead: (
        er: (Error | { message?: string; name?: string }) & {
            generatedMessage?: string;
        },
        cls: string,
    ) => string

    start of an Error object

    errorTail: (indent: string) => string

    end of an Error object

    fn: (fn: Function | ((...a: any[]) => any), cls: string) => string

    a function, optionally with a class name

    mapEmpty: (cls: string) => string

    an empty Map

    mapEntrySep: () => string

    separator between entries in a Map

    mapHead: (cls: string) => string

    start of a Map

    mapKeyStart: () => string

    start of a key in a Map

    mapKeyValSep: () => string

    separator between key and value in a Map

    mapTail: (indent: string) => string

    end of a Map

    nodeId: (id: number) => string

    how to print node identifiers for circular references

    pojoEmpty: (cls: string) => string

    empty JavaScript object

    pojoEntrySep: () => string

    separator between entries in a JavaScript object

    pojoHead: (cls: string) => string

    start of a JavaScript object

    pojoKeyValSep: () => string

    separator between key and value in a JavaScript object

    pojoTail: (indent: string) => string

    end of a JavaScript object

    reactElement?: (node: ReactNode) => string

    a react element

    setEmpty: (cls: string) => string

    an empty Set

    setEntrySep: () => string

    separator between entries in a Set

    setHead: (cls: string) => string

    start of a Set

    setTail: (indent: string) => string

    end of a Set

    start: (indent: string, key: string, sep: string) => string

    beginning of a thing being printed

    stringEmpty: () => string

    an empty string

    stringHead: () => string

    start of a long string

    stringLine: (str: string) => string

    each line of a long string

    stringLineSep: () => string

    separator between lines of a long string

    stringOneLine: (str: string) => string

    a string that fits on one line

    stringTail: (indent: string) => string

    end of a long string

    symbol: (method: string, key: string) => string

    printing symbols

    Settings

    Member Visibility

    On This Page

    Properties