Class Format

The base class for all other comparators, and used directly by comparators for their "simplePrint" methods. It doesn't do comparison, just formatting.

Hierarchy (view full)

Format
- Same

Index

Constructors

constructor

new Format(obj, options?): Format
Parameters
- obj: any
- options: FormatOptions = {}
Returns Format
- Defined in src/tcompare/src/format.ts:119

Properties

bufferChunkSize

bufferChunkSize: number

expect

expect: any

id

id: null | number

idCounter

idCounter: number

idMap

idMap: Map<any, number>

indent

indent: string

isKey

isKey: boolean

key

key: any

level

level: number

match

match: boolean

memo

memo: null | string

object

object: any

options

options: FormatOptions

parent

parent: null | Format

sort

sort: boolean

style

style: Style

Accessors

objectAsArray

get objectAsArray(): null | any[]
Returns null | any[]
- Defined in src/tcompare/src/format.ts:314

Methods

arrayIsEmpty

arrayIsEmpty(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:741

bufferIsShort

bufferIsShort(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:550

child

child(obj, options, cls?): any
Parameters
- obj: any
- options: FormatOptions
- Optionalcls: typeof Format
Returns any
- Defined in src/tcompare/src/format.ts:194

errorIsEmpty

errorIsEmpty(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:782

getClass

getClass(): string
Returns string
- Defined in src/tcompare/src/format.ts:299

getId

getId(): number
Returns number
- Defined in src/tcompare/src/format.ts:167

getKey

getKey(): string
Returns string
- Defined in src/tcompare/src/format.ts:495

getMapEntries

getMapEntries(obj?): [string, any][]
Parameters
- obj: any = ...
Returns [string, any][]
- Defined in src/tcompare/src/format.ts:642

getPojoEntries

getPojoEntries(obj): [PropertyKey, any][]
Parameters
- obj: any
Returns [PropertyKey, any][]
- Defined in src/tcompare/src/format.ts:892

getPojoKeys

getPojoKeys(obj?): PropertyKey[]
Parameters
- obj: any = ...
Returns PropertyKey[]
- Defined in src/tcompare/src/format.ts:814

incId

incId(): number
Returns number
- Defined in src/tcompare/src/format.ts:163

indentLevel

indentLevel(n?): string
Parameters
- n: number = 0
Returns string
- Defined in src/tcompare/src/format.ts:509

isArguments

isArguments(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:212

isArray

isArray(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:216

isBuffer

isBuffer(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:289

isError

isError(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:208

isIterable

isIterable(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:248

isKeyless

isKeyless(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:259

isMap

isMap(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:281

isReactElement

isReactElement(element?): boolean
Parameters
- element: any = ...
Returns boolean
- Defined in src/tcompare/src/format.ts:224

isReactElementChildren

isReactElementChildren(children): boolean
Parameters
- children: any
Returns boolean
- Defined in src/tcompare/src/format.ts:235

isSet

isSet(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:285

isStream

isStream(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:269

isString

isString(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:293

mapIsEmpty

mapIsEmpty(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:630

nodeId

nodeId(): string
Returns string
- Defined in src/tcompare/src/format.ts:526

pojoIsEmpty

pojoIsEmpty(obj?): boolean
Parameters
- obj: any = ...
Returns boolean
- Defined in src/tcompare/src/format.ts:867

print

print(): string
Returns string
- Defined in src/tcompare/src/format.ts:338

printArray

printArray(): void
Returns void
- Defined in src/tcompare/src/format.ts:731

printArrayBody

printArrayBody(): void
Returns void
- Defined in src/tcompare/src/format.ts:754

printArrayEmpty

printArrayEmpty(): void
Returns void
- Defined in src/tcompare/src/format.ts:746

printArrayEntry

printArrayEntry(key, val): void
Parameters
- key: any
- val: any
Returns void
- Defined in src/tcompare/src/format.ts:766

printArrayHead

printArrayHead(): void
Returns void
- Defined in src/tcompare/src/format.ts:750

printArrayTail

printArrayTail(): void
Returns void
- Defined in src/tcompare/src/format.ts:762

printBigInt

printBigInt(): void
Returns void
- Defined in src/tcompare/src/format.ts:454

printBoolean

printBoolean(): void
Returns void
- Defined in src/tcompare/src/format.ts:458

printBuffer

printBuffer(): void
Returns void
- Defined in src/tcompare/src/format.ts:530

printBufferBody

printBufferBody(): void
Returns void
- Defined in src/tcompare/src/format.ts:558

printBufferHead

printBufferHead(): void
Returns void
- Defined in src/tcompare/src/format.ts:554

printBufferLastLine

printBufferLastLine(key, val): void
Parameters
- key: any
- val: Buffer
Returns void
- Defined in src/tcompare/src/format.ts:572

printBufferLine

printBufferLine(key, val): void
Parameters
- key: number
- val: Buffer
Returns void
- Defined in src/tcompare/src/format.ts:567

printBufferTail

printBufferTail(): void
Returns void
- Defined in src/tcompare/src/format.ts:578

printCircular

printCircular(seen): void
Parameters
- seen: Format
Returns void
- Defined in src/tcompare/src/format.ts:505

printCollection

printCollection(): void
Returns void
- Defined in src/tcompare/src/format.ts:513

printDate

printDate(): void
Returns void
- Defined in src/tcompare/src/format.ts:417

printEnd

printEnd(): void
Returns void
- Defined in src/tcompare/src/format.ts:481

printError

printError(): void
Returns void
- Defined in src/tcompare/src/format.ts:772

printErrorBody

printErrorBody(): void
Returns void
- Defined in src/tcompare/src/format.ts:798

printErrorEmpty

printErrorEmpty(): void
Returns void
- Defined in src/tcompare/src/format.ts:786

printErrorHead

printErrorHead(): void
Returns void
- Defined in src/tcompare/src/format.ts:790

printErrorTail

printErrorTail(): void
Returns void
- Defined in src/tcompare/src/format.ts:794

printFn

printFn(): void
Returns void
- Defined in src/tcompare/src/format.ts:668

printMap

printMap(): void
Returns void
- Defined in src/tcompare/src/format.ts:620

printMapBody

printMapBody(): void
Returns void
- Defined in src/tcompare/src/format.ts:652

printMapEmpty

printMapEmpty(): void
Returns void
- Defined in src/tcompare/src/format.ts:634

printMapEntry

printMapEntry(key, val): void
Parameters
- key: any
- val: any
Returns void
- Defined in src/tcompare/src/format.ts:662

printMapHead

printMapHead(): void
Returns void
- Defined in src/tcompare/src/format.ts:638

printMapTail

printMapTail(): void
Returns void
- Defined in src/tcompare/src/format.ts:658

printNull

printNull(): void
Returns void
- Defined in src/tcompare/src/format.ts:429

printNumber

printNumber(): void
Returns void
- Defined in src/tcompare/src/format.ts:462

printPojo

printPojo(): void
Returns void
- Defined in src/tcompare/src/format.ts:857

printPojoBody

printPojoBody(): void
Returns void
- Defined in src/tcompare/src/format.ts:885

printPojoEmpty

printPojoEmpty(): void
Returns void
- Defined in src/tcompare/src/format.ts:871

printPojoEntry

printPojoEntry(key, val): void
Parameters
- key: any
- val: any
Returns void
- Defined in src/tcompare/src/format.ts:911

printPojoHead

printPojoHead(): void
Returns void
- Defined in src/tcompare/src/format.ts:875

printPojoTail

printPojoTail(): void
Returns void
- Defined in src/tcompare/src/format.ts:907

printReactElement

printReactElement(): void
Returns void
- Defined in src/tcompare/src/format.ts:404

printRegExp

printRegExp(): void
Returns void
- Defined in src/tcompare/src/format.ts:421

printSet

printSet(): void
Returns void
- Defined in src/tcompare/src/format.ts:582

printSetBody

printSetBody(): void
Returns void
- Defined in src/tcompare/src/format.ts:604

printSetEmpty

printSetEmpty(): void
Returns void
- Defined in src/tcompare/src/format.ts:596

printSetEntry

printSetEntry(val): void
Parameters
- val: any
Returns void
- Defined in src/tcompare/src/format.ts:614

printSetHead

printSetHead(): void
Returns void
- Defined in src/tcompare/src/format.ts:600

printSetTail

printSetTail(): void
Returns void
- Defined in src/tcompare/src/format.ts:610

printStart

printStart(): void
Returns void
- Defined in src/tcompare/src/format.ts:466

printString

printString(): void
Returns void
- Defined in src/tcompare/src/format.ts:672

printStringBody

printStringBody(): void
Returns void
- Defined in src/tcompare/src/format.ts:706

printStringEmpty

printStringEmpty(): void
Returns void
- Defined in src/tcompare/src/format.ts:690

printStringHead

printStringHead(): void
Returns void
- Defined in src/tcompare/src/format.ts:702

printStringLastLine

printStringLastLine(key, val): void
Parameters
- key: any
- val: string
Returns void
- Defined in src/tcompare/src/format.ts:721

printStringLine

printStringLine(key, val): void
Parameters
- key: any
- val: string
Returns void
- Defined in src/tcompare/src/format.ts:716

printStringOneLine

printStringOneLine(): void
Returns void
- Defined in src/tcompare/src/format.ts:698

printStringTail

printStringTail(): void
Returns void
- Defined in src/tcompare/src/format.ts:727

printSymbol

printSymbol(): void
Returns void
- Defined in src/tcompare/src/format.ts:450

printUndefined

printUndefined(): void
Returns void
- Defined in src/tcompare/src/format.ts:425

printValue

printValue(): void
Returns void
- Defined in src/tcompare/src/format.ts:360

seen

seen(_?): false | Format
Parameters
- Optional_: any
Returns false | Format
- Defined in src/tcompare/src/format.ts:180

setIsEmpty

setIsEmpty(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:592

stringIsEmpty

stringIsEmpty(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:686

stringIsOneLine

stringIsOneLine(): boolean
Returns boolean
- Defined in src/tcompare/src/format.ts:694

Class Format

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Format

Properties

bufferChunkSize

expect

id

idCounter

idMap

indent

isKey

key

level

match

memo

object

options

parent

sort

style

Accessors

objectAsArray

Returns null | any[]

Methods

arrayIsEmpty

Returns boolean

bufferIsShort

Returns boolean

child

Parameters

Returns any

errorIsEmpty

Returns boolean

getClass

Returns string

getId

Returns number

getKey

Returns string

getMapEntries

Parameters

Returns [string, any][]

getPojoEntries

Parameters

Returns [PropertyKey, any][]

getPojoKeys

Parameters

Returns PropertyKey[]

incId

Returns number

indentLevel

Parameters

Returns string

isArguments

Returns boolean

isArray

Returns boolean

isBuffer

Returns boolean

isError

Returns boolean

isIterable

Returns boolean

isKeyless

Returns boolean

isMap

Returns boolean

isReactElement

Parameters

Returns boolean

isReactElementChildren

Parameters