Loxer - v3.0.0
    Preparing search index...

    Interface PropsPrinterOptions

    the options to configure the "default" output of a log's props

    interface PropsPrinterOptions {
        depth?: number;
        printFunction?: boolean;
        indent?: number;
        showVerticalLines?: boolean;
        keys?: string[];
        shortenClasses?: boolean;
    }
    Index
    depth?: number

    at which object / array depth, other objects / arrays should just be displayed as their type + length.

    • left out, the depth has no configured limit; a safety limit of 100 protects the call stack
    • a finite number is truncated and clamped to 0 through that safety limit, so depth: 0 renders even the outermost object as {3 entries}; a non-finite number uses the default
    printFunction?: boolean

    should a function be printed with its complete declaration. defaults to false

    indent?: number

    the indent that nested objects / arrays have (when not shortened to 1 line). Defaults to 2; a finite number is truncated and clamped from 0 through 20, and a non-finite value uses the default.

    showVerticalLines?: boolean

    should vertical indent indicator lines be printed. defaults to true

    keys?: string[]

    filtered keys for objects.

    • helpful for larger objects
    • other keys will not be displayed
    • objects and arrays that deeply contain the given keys will have an indicator of how many elements where left out
    shortenClasses?: boolean

    shortens objects that have a specific constructor name (other than 'Object') as their name

    • defaults to true (except if the prop itself is a class)
    • if disabled, the object will be displayed as destructed object with its properties
    • ATTENTION displaying nested classes (classes have classes as props) can lead to exceeding the stack size, especially if the contain cyclic structures