Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChaiUtils

Hierarchy

  • ChaiUtils

Index

Methods

Methods

addChainableMethod

  • addChainableMethod(ctx: object, name: string, method: (...args: any[]) => void, chainingBehavior?: () => void): void

  • Parameters

    • ctx: object
    • name: string
    • method: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional chainingBehavior: () => void
        • (): void

        • Returns void

    Returns void

addLengthGuard

  • addLengthGuard(fn: Function, assertionName: string, isChainable: boolean): void

  • Parameters

    • fn: Function
    • assertionName: string
    • isChainable: boolean

    Returns void

addMethod

  • addMethod(ctx: object, name: string, method: Function): void

  • Parameters

    • ctx: object
    • name: string
    • method: Function

    Returns void

addProperty

  • addProperty(ctx: object, name: string, getter: () => any): void

  • Parameters

    • ctx: object
    • name: string
    • getter: () => any
        • (): any

        • Returns any

    Returns void

compareByInspect

  • compareByInspect(a: object, b: object): 1 | -1

  • Parameters

    • a: object
    • b: object

    Returns 1 | -1

compatibleConstructor

compatibleInstance

compatibleMessage

  • compatibleMessage(thrown: Error, errMatcher: string | RegExp): boolean

  • Parameters

    Returns boolean

expectTypes

  • expectTypes(obj: object, types: string[]): void

  • Parameters

    • obj: object
    • types: string[]

    Returns void

flag

  • flag(obj: object, key: string, value?: any): any

  • Parameters

    • obj: object
    • key: string
    • Optional value: any

    Returns any

getActual

  • Parameters

    Returns any

getConstructorName

  • getConstructorName(constructorFn: Function): string

  • Parameters

    Returns string

getEnumerableProperties

  • getEnumerableProperties(obj: object): string[]

  • Parameters

    • obj: object

    Returns string[]

getFuncName

  • getFuncName(constructorFn: Function): null | string

  • Parameters

    Returns null | string

getMessage

  • getMessage(errorLike: string | Error): string
  • getMessage(obj: any, args: AssertionArgs): string

  • Parameters

    • errorLike: string | Error

    Returns string

  • Parameters

    Returns string

getOwnEnumerableProperties

  • getOwnEnumerableProperties(obj: object): (string | symbol)[]

  • Parameters

    • obj: object

    Returns (string | symbol)[]

getOwnEnumerablePropertySymbols

  • getOwnEnumerablePropertySymbols(obj: object): symbol[]

  • Parameters

    • obj: object

    Returns symbol[]

getPathInfo

  • getPathInfo(obj: object, path: string): PathInfo

  • Parameters

    • obj: object
    • path: string

    Returns PathInfo

getPathValue

  • getPathValue(obj: object, path: string): undefined | object

  • Parameters

    • obj: object
    • path: string

    Returns undefined | object

getProperties

  • getProperties(obj: object): string[]

  • Parameters

    • obj: object

    Returns string[]

hasProperty

  • hasProperty(obj: undefined | null | object, name: ObjectProperty): boolean

  • Parameters

    Returns boolean

inspect

  • inspect(obj: any, showHidden?: boolean, depth?: number, colors?: boolean): string

  • Parameters

    • obj: any
    • Optional showHidden: boolean
    • Optional depth: number
    • Optional colors: boolean

    Returns string

isProxyEnabled

  • isProxyEnabled(): boolean

  • Returns boolean

objDisplay

  • objDisplay(obj: object): void

  • Parameters

    • obj: object

    Returns void

overwriteChainableMethod

  • overwriteChainableMethod(ctx: object, name: string, method: (...args: any[]) => void, chainingBehavior?: () => void): void

  • Parameters

    • ctx: object
    • name: string
    • method: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional chainingBehavior: () => void
        • (): void

        • Returns void

    Returns void

overwriteMethod

  • overwriteMethod(ctx: object, name: string, method: Function): void

  • Parameters

    • ctx: object
    • name: string
    • method: Function

    Returns void

overwriteProperty

  • overwriteProperty(ctx: object, name: string, getter: () => any): void

  • Parameters

    • ctx: object
    • name: string
    • getter: () => any
        • (): any

        • Returns any

    Returns void

proxify

  • proxify(obj: object, nonChainableMethodName: string): object

  • Parameters

    • obj: object
    • nonChainableMethodName: string

    Returns object

test

  • Parameters

    Returns boolean

transferFlags

  • transferFlags(assertion: Assertion, obj: object, includeAll?: boolean): void

  • Parameters

    • assertion: Assertion
    • obj: object
    • Optional includeAll: boolean

    Returns void