Class MatchOnly

this uses the test method from tcompare!match.Match, but requires that only the specified fields in the pattern are present in the object.

It does still allow a field to be present in the object and not the pattern if the value is set to null or undefined.

Hierarchy (view full)

Same
- MatchOnly

Index

Constructors

constructor

new MatchOnly(obj, options): MatchOnly
Parameters
- obj: any
- options: SameOptions
Returns MatchOnly
Inherited from Same.constructor
- Defined in src/tcompare/src/same.ts:63

Properties

bufferChunkSize

bufferChunkSize: number

diffContext

diffContext: number = 10

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 = true

memo

memo: null | string

memoDiff

memoDiff: null | string = null

memoExpect

memoExpect: null | string = null

object

object: any

options

options: FormatOptions

parent

parent: null | Same

provisional

provisional: boolean

simple

simple: null | boolean | "COMPLEX" = null

sort

sort: boolean

style

style: Style

Accessors

expectAsArray

get expectAsArray(): null | any[]
Returns null | any[]
Inherited from Same.expectAsArray
- Defined in src/tcompare/src/same.ts:281

objectAsArray

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

Methods

arrayExpectIsEmpty

arrayExpectIsEmpty(): boolean
Returns boolean
Inherited from Same.arrayExpectIsEmpty
- Defined in src/tcompare/src/same.ts:619

arrayIsEmpty

arrayIsEmpty(): boolean
Returns boolean
Inherited from Same.arrayIsEmpty
- Defined in src/tcompare/src/same.ts:616

bufferIsShort

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

child

child(obj, options, cls?): any
Parameters
- obj: any
- options: FormatOptions | SameOptions
- Optionalcls: typeof Same
Returns any
Inherited from Same.child
- Defined in src/tcompare/src/same.ts:250

childExpect

childExpect(key): any
Parameters
- key: any
Returns any
Inherited from Same.childExpect
- Defined in src/tcompare/src/same.ts:269

diff

diff(): string
Returns string
Inherited from Same.diff
- Defined in src/tcompare/src/same.ts:223

errorIsEmpty

errorIsEmpty(): boolean
Returns boolean
Inherited from Same.errorIsEmpty
- Defined in src/tcompare/src/same.ts:461

expectErrorIsEmpty

expectErrorIsEmpty(): boolean
Returns boolean
Inherited from Same.expectErrorIsEmpty
- Defined in src/tcompare/src/same.ts:464

getClass

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

getId

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

getKey

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

getMapEntries

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

getPojoEntries

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

getPojoKeys

getPojoKeys(obj?): PropertyKey[]
Parameters
- obj: any = ...
Returns PropertyKey[]
Inherited from Same.getPojoKeys
- Defined in src/tcompare/src/same.ts:398

incId

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

indentLevel

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

isArguments

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

isArray

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

isBuffer

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

isError

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

isIterable

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

isKeyless

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

isMap

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

isReactElement

isReactElement(): boolean
Returns boolean
Inherited from Same.isReactElement
- Defined in src/tcompare/src/same.ts:334

isReactElementChildren

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

isSet

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

isStream

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

isString

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

mapExpectIsEmpty

mapExpectIsEmpty(): boolean
Returns boolean
Inherited from Same.mapExpectIsEmpty
- Defined in src/tcompare/src/same.ts:503

mapIsEmpty

mapIsEmpty(): boolean
Returns boolean
Inherited from Same.mapIsEmpty
- Defined in src/tcompare/src/same.ts:500

nodeId

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

pojoExpectIsEmpty

pojoExpectIsEmpty(): boolean
Returns boolean
Inherited from Same.pojoExpectIsEmpty
- Defined in src/tcompare/src/same.ts:392

pojoIsEmpty

pojoIsEmpty(): boolean
Returns boolean
Inherited from Same.pojoIsEmpty
- Defined in src/tcompare/src/same.ts:389

print

print(): string
Returns string
Inherited from Same.print
- Defined in src/tcompare/src/same.ts:188

printArray

printArray(): void
Returns void
Inherited from Same.printArray
- Defined in src/tcompare/src/same.ts:609

printArrayBody

printArrayBody(): void
Returns void
Inherited from Same.printArrayBody
- Defined in src/tcompare/src/same.ts:626

printArrayEmpty

printArrayEmpty(): void
Returns void
Inherited from Same.printArrayEmpty
- Defined in src/tcompare/src/same.ts:623

printArrayEntry

printArrayEntry(key, val): void
Parameters
- key: number
- val: any
Returns void
Inherited from Same.printArrayEntry
- Defined in src/tcompare/src/same.ts:642

printArrayHead

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

printArrayTail

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

printBigInt

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

printBoolean

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

printBuffer

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

printBufferBody

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

printBufferHead

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

printBufferLastLine

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

printBufferLine

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

printBufferTail

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

printCircular

printCircular(seen): void
Parameters
- seen: Format
Returns void
Inherited from Same.printCircular
- Defined in src/tcompare/src/same.ts:214

printCollection

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

printDate

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

printEnd

printEnd(): void
Returns void
Inherited from Same.printEnd
- Defined in src/tcompare/src/same.ts:317

printError

printError(): void
Returns void
Inherited from Same.printError
- Defined in src/tcompare/src/same.ts:448

printErrorBody

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

printErrorEmpty

printErrorEmpty(): void
Returns void
Inherited from Same.printErrorEmpty
- Defined in src/tcompare/src/same.ts:471

printErrorHead

printErrorHead(): void
Returns void
Inherited from Same.printErrorHead
- Defined in src/tcompare/src/same.ts:474

printErrorTail

printErrorTail(): void
Returns void
Inherited from Same.printErrorTail
- Defined in src/tcompare/src/same.ts:480

printFn

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

printMap

printMap(): void
Returns void
Inherited from Same.printMap
- Defined in src/tcompare/src/same.ts:487

printMapBody

printMapBody(): void
Returns void
Inherited from Same.printMapBody
- Defined in src/tcompare/src/same.ts:516

printMapEmpty

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

printMapEntry

printMapEntry(key, val, expectKey?): void
Parameters
- key: any
- val: any
- expectKey: any = key
Returns void
Inherited from Same.printMapEntry
- Defined in src/tcompare/src/same.ts:569

printMapEntryNotFound

printMapEntryNotFound(key, val): void
Parameters
- key: any
- val: any
Returns void
Inherited from Same.printMapEntryNotFound
- Defined in src/tcompare/src/same.ts:575

printMapEntryUnexpected

printMapEntryUnexpected(key, val): void
Parameters
- key: any
- val: any
Returns void
Inherited from Same.printMapEntryUnexpected
- Defined in src/tcompare/src/same.ts:583

printMapHead

printMapHead(): void
Returns void
Inherited from Same.printMapHead
- Defined in src/tcompare/src/same.ts:506

printMapTail

printMapTail(): void
Returns void
Inherited from Same.printMapTail
- Defined in src/tcompare/src/same.ts:511

printNull

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

printNumber

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

printPojo

printPojo(): void
Returns void
Inherited from Same.printPojo
- Defined in src/tcompare/src/same.ts:370

printPojoBody

printPojoBody(): void
Returns void
Inherited from Same.printPojoBody
- Defined in src/tcompare/src/same.ts:418

printPojoEmpty

printPojoEmpty(): void
Returns void
Inherited from Same.printPojoEmpty
- Defined in src/tcompare/src/same.ts:395

printPojoEntry

printPojoEntry(key, val, notFound?): void
Parameters
- key: any
- val: any
- OptionalnotFound: boolean
Returns void
Inherited from Same.printPojoEntry
- Defined in src/tcompare/src/same.ts:436

printPojoHead

printPojoHead(): void
Returns void
Inherited from Same.printPojoHead
- Defined in src/tcompare/src/same.ts:407

printPojoTail

printPojoTail(): void
Returns void
Inherited from Same.printPojoTail
- Defined in src/tcompare/src/same.ts:413

printReactElement

printReactElement(): void
Returns void
Inherited from Same.printReactElement
- Defined in src/tcompare/src/same.ts:340

printRegExp

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

printSet

printSet(): void
Returns void
Inherited from Same.printSet
- Defined in src/tcompare/src/same.ts:647

printSetBody

printSetBody(): void
Returns void
Inherited from Same.printSetBody
- Defined in src/tcompare/src/same.ts:660

printSetEmpty

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

printSetEntry

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

printSetHead

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

printSetTail

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

printStart

printStart(): void
Returns void
Inherited from Same.printStart
- Defined in src/tcompare/src/same.ts:292

printString

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

printStringBody

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

printStringEmpty

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

printStringHead

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

printStringLastLine

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

printStringLine

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

printStringOneLine

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

printStringTail

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

printSymbol

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

printUndefined

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

printValue

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

regexpSame

regexpSame(a, b): boolean
Parameters
- a: RegExp
- b: RegExp
Returns boolean
Inherited from Same.regexpSame
- Defined in src/tcompare/src/same.ts:138

seen

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

seenExpect

seenExpect(): false | Same
Returns false | Same
Inherited from Same.seenExpect
- Defined in src/tcompare/src/same.ts:170

setExpectIsEmpty

setExpectIsEmpty(): boolean
Returns boolean
Inherited from Same.setExpectIsEmpty
- Defined in src/tcompare/src/same.ts:654

setIsEmpty

setIsEmpty(): boolean
Returns boolean
Inherited from Same.setIsEmpty
- Defined in src/tcompare/src/same.ts:657

simpleMatch

simpleMatch(): void
Returns void
Inherited from Same.simpleMatch
- Defined in src/tcompare/src/same.ts:86

simplePrint

simplePrint(obj, options?): string
Parameters
- obj: any
- options: FormatOptions = {}
Returns string
Inherited from Same.simplePrint
- Defined in src/tcompare/src/same.ts:156

simplePrintExpect

simplePrintExpect(): string
Returns string
Inherited from Same.simplePrintExpect
- Defined in src/tcompare/src/same.ts:163

stringIsEmpty

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

stringIsOneLine

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

test

test(): boolean | "COMPLEX"
Returns boolean | "COMPLEX"
Overrides Same.test
- Defined in src/tcompare/src/match-only.ts:12

unmatch

unmatch(): void
Returns void
Inherited from Same.unmatch
- Defined in src/tcompare/src/same.ts:146

Class MatchOnly

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MatchOnly

Properties

bufferChunkSize

diffContext

expect

id

idCounter

idMap

indent

isKey

key

level

match

memo

memoDiff

memoExpect

object

options

parent

provisional

simple

sort

style

Accessors

expectAsArray

Returns null | any[]

objectAsArray

Returns null | any[]

Methods

arrayExpectIsEmpty

Returns boolean

arrayIsEmpty

Returns boolean

bufferIsShort

Returns boolean

child

Parameters

Returns any

childExpect

Parameters

Returns any

diff

Returns string

errorIsEmpty

Returns boolean

expectErrorIsEmpty

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