Interface FormatOptions

Options to control the formatting of objects.

interface FormatOptions {
    bufferChunkSize?: number;
    expect?: any;
    includeEnumerable?: boolean;
    includeGetters?: boolean;
    indent?: string;
    isKey?: boolean;
    key?: any;
    level?: number;
    parent?: Format;
    provisional?: boolean;
    reactString?: boolean;
    seen?: ((obj?) => false | Format);
    sort?: boolean;
    style?: StyleType;
}

Hierarchy (view full)

Properties

bufferChunkSize? expect? includeEnumerable? includeGetters? indent? isKey? key? level? parent? provisional? reactString? seen? sort? style?

Properties

Optional bufferChunkSize

bufferChunkSize?: number

optinally override tcompare!styles.Style#bufferChunkSize

Optional Internal expect

expect?: any

The object being compared against in comparison classes. (Not used in tcompare!format.Format.)

Optional includeEnumerable

includeEnumerable?: boolean

Include any and all enumerable properties, including those inherited on the prototype chain. By default, only own properties are printed.

Optional includeGetters

includeGetters?: boolean

Include getter properties

Optional Internal indent

indent?: string

indentation level of this object within the object graph

Optional Internal isKey

isKey?: boolean

used when formatting Map keys

Optional Internal key

key?: any

Set when printing child fields

Optional Internal level

level?: number

level within the object graph being printed

Optional Internal parent

parent?: Format

set when formatting keys and values of collections

Optional Internal provisional

provisional?: boolean

used when provisionally exploring a path for comparison

Optional reactString

reactString?: boolean

Represent and compare react elements as JSX strings.

Only supported in the 'pretty' formatting style.

Optional Internal seen

seen?: ((obj?) => false | Format)

test whether an object has been seen, and get a reference to the Format handling them, if so.

overridden in child classes when doing simplePrint()

Type declaration

    • (obj?): false | Format

    • Parameters

      • Optional obj: any

      Returns false | Format

Optional sort

sort?: boolean

sort items alphabetically by key

Optional style

style?: StyleType

how to print this thing

Settings

Member Visibility

Theme

On This Page

bufferChunkSizeexpectincludeEnumerableincludeGettersindentisKeykeylevelparentprovisionalreactStringseensortstyle

Generated using TypeDoc