Interface MatcherUtils

BOLD_WEIGHT: MatcherColorFn

DIM_COLOR: MatcherColorFn

EXPECTED_COLOR: MatcherColorFn

INVERTED_COLOR: MatcherColorFn

RECEIVED_COLOR: MatcherColorFn

SUGGEST_TO_CONTAIN_EQUAL: string

iterableEquality: EqualityTester

subsetEquality: EqualityTester

diff: function

• diff(a: any, b: any, options?: undefined | { aAnnotation?: undefined | string; aColor?: DiffOptionsColor; aIndicator?: undefined | string; bAnnotation?: undefined | string; bColor?: DiffOptionsColor; bIndicator?: undefined | string; changeColor?: DiffOptionsColor; changeLineTrailingSpaceColor?: DiffOptionsColor; commonColor?: DiffOptionsColor; commonIndicator?: undefined | string; commonLineTrailingSpaceColor?: DiffOptionsColor; contextLines?: undefined | number; emptyFirstOrLastLinePlaceholder?: undefined | string; expand?: undefined | false | true; includeChangeCounts?: undefined | false | true; omitAnnotationLines?: undefined | false | true; patchColor?: DiffOptionsColor }): string | null

• Parameters

  • a: any

  • b: any

  • Optional options: undefined | { aAnnotation?: undefined | string; aColor?: DiffOptionsColor; aIndicator?: undefined | string; bAnnotation?: undefined | string; bColor?: DiffOptionsColor; bIndicator?: undefined | string; changeColor?: DiffOptionsColor; changeLineTrailingSpaceColor?: DiffOptionsColor; commonColor?: DiffOptionsColor; commonIndicator?: undefined | string; commonLineTrailingSpaceColor?: DiffOptionsColor; contextLines?: undefined | number; emptyFirstOrLastLinePlaceholder?: undefined | string; expand?: undefined | false | true; includeChangeCounts?: undefined | false | true; omitAnnotationLines?: undefined | false | true; patchColor?: DiffOptionsColor }

  Returns string | null

ensureActualIsNumber: function

• ensureActualIsNumber(actual: any, matcherName: string, options?: MatcherHintOptions): void

• Parameters

  • actual: any

  • matcherName: string

  • Optional options: MatcherHintOptions

  Returns void

ensureExpectedIsNonNegativeInteger: function

• ensureExpectedIsNonNegativeInteger(expected: any, matcherName: string, options?: MatcherHintOptions): void

• Parameters

  • expected: any

  • matcherName: string

  • Optional options: MatcherHintOptions

  Returns void

ensureExpectedIsNumber: function

• ensureExpectedIsNumber(actual: any, matcherName: string, options?: MatcherHintOptions): void

• Parameters

  • actual: any

  • matcherName: string

  • Optional options: MatcherHintOptions

  Returns void

ensureNoExpected: function

• ensureNoExpected(actual: any, matcherName: string, options?: MatcherHintOptions): void

• Parameters

  • actual: any

  • matcherName: string

  • Optional options: MatcherHintOptions

  Returns void

ensureNumbers: function

• ensureNumbers(actual: any, expected: any, matcherName: string, options?: MatcherHintOptions): void

• Parameters

  • actual: any

  • expected: any

  • matcherName: string

  • Optional options: MatcherHintOptions

  Returns void

getLabelPrinter: function

• getLabelPrinter(...strings: string[]): PrintLabel

• Parameters

  • Rest ...strings: string[]

  Returns PrintLabel

highlightTrailingWhitespace: function

• highlightTrailingWhitespace(text: string): string

• Parameters

  • text: string

  Returns string

matcherErrorMessage: function

• matcherErrorMessage(hint: string, generic: string, specific: string): string

• Parameters

  • hint: string

  • generic: string

  • specific: string

  Returns string

matcherHint: function

• matcherHint(matcherName: string, received?: undefined | string, expected?: undefined | string, options?: MatcherHintOptions): string

• Parameters

  • matcherName: string

  • Optional received: undefined | string

  • Optional expected: undefined | string

  • Optional options: MatcherHintOptions

  Returns string

pluralize: function

• pluralize(word: string, count: number): string

• Parameters

  • word: string

  • count: number

  Returns string

printDiffOrStringify: function

• printDiffOrStringify(expected: any, received: any, expectedLabel: string, receivedLabel: string, expand: boolean): string

• Parameters

  • expected: any

  • received: any

  • expectedLabel: string

  • receivedLabel: string

  • expand: boolean

  Returns string

printExpected: function

• printExpected(value: any): string

• Parameters

  • value: any

  Returns string

printReceived: function

• printReceived(object: any): string

• Parameters

  • object: any

  Returns string

printWithType: function

• printWithType(name: string, value: any, print: (value: any) => string): string

• Parameters

  • name: string

  • value: any

  • print: (value: any) => string

    • • (value: any): string

      • Parameters

        • value: any

        Returns string

  Returns string

stringify: function

• stringify(object: {}, maxDepth?: undefined | number): string

• Parameters

  • object: {}

  • Optional maxDepth: undefined | number

  Returns string