Options
All
  • Public
  • Public/Protected
  • All
Menu

Callable

  • internal(value: any, message?: string | Error): void
  • Parameters

    • value: any
    • Optional message: string | Error

    Returns void

Index

Variables

Const strict

strict: internal

Functions

deepEqual

  • deepEqual(actual: any, expected: any, message?: string | Error): void
  • deprecated

    since v9.9.0 - use deepStrictEqual() instead.

    Parameters

    • actual: any
    • expected: any
    • Optional message: string | Error

    Returns void

deepStrictEqual

  • deepStrictEqual(actual: any, expected: any, message?: string | Error): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string | Error

    Returns void

doesNotReject

  • doesNotReject(block: function | Promise<any>, message?: string | Error): Promise<void>
  • doesNotReject(block: function | Promise<any>, error: RegExp | Function, message?: string | Error): Promise<void>
  • Parameters

    • block: function | Promise<any>
    • Optional message: string | Error

    Returns Promise<void>

  • Parameters

    • block: function | Promise<any>
    • error: RegExp | Function
    • Optional message: string | Error

    Returns Promise<void>

doesNotThrow

  • doesNotThrow(block: function, message?: string | Error): void
  • doesNotThrow(block: function, error: RegExp | Function, message?: string | Error): void
  • Parameters

    • block: function
        • (): any
        • Returns any

    • Optional message: string | Error

    Returns void

  • Parameters

    • block: function
        • (): any
        • Returns any

    • error: RegExp | Function
    • Optional message: string | Error

    Returns void

equal

  • equal(actual: any, expected: any, message?: string | Error): void
  • deprecated

    since v9.9.0 - use strictEqual() instead.

    Parameters

    • actual: any
    • expected: any
    • Optional message: string | Error

    Returns void

fail

  • fail(message?: string | Error): never
  • fail(actual: any, expected: any, message?: string | Error, operator?: undefined | string, stackStartFn?: Function): never
  • Parameters

    • Optional message: string | Error

    Returns never

  • deprecated

    since v10.0.0 - use fail([message]) or other assert functions instead.

    Parameters

    • actual: any
    • expected: any
    • Optional message: string | Error
    • Optional operator: undefined | string
    • Optional stackStartFn: Function

    Returns never

ifError

  • ifError(value: any): void
  • Parameters

    • value: any

    Returns void

notDeepEqual

  • notDeepEqual(actual: any, expected: any, message?: string | Error): void
  • deprecated

    since v9.9.0 - use notDeepStrictEqual() instead.

    Parameters

    • actual: any
    • expected: any
    • Optional message: string | Error

    Returns void

notDeepStrictEqual

  • notDeepStrictEqual(actual: any, expected: any, message?: string | Error): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string | Error

    Returns void

notEqual

  • notEqual(actual: any, expected: any, message?: string | Error): void
  • deprecated

    since v9.9.0 - use notStrictEqual() instead.

    Parameters

    • actual: any
    • expected: any
    • Optional message: string | Error

    Returns void

notStrictEqual

  • notStrictEqual(actual: any, expected: any, message?: string | Error): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string | Error

    Returns void

ok

  • ok(value: any, message?: string | Error): void
  • Parameters

    • value: any
    • Optional message: string | Error

    Returns void

rejects

  • rejects(block: function | Promise<any>, message?: string | Error): Promise<void>
  • rejects(block: function | Promise<any>, error: RegExp | Function | Object | Error, message?: string | Error): Promise<void>
  • Parameters

    • block: function | Promise<any>
    • Optional message: string | Error

    Returns Promise<void>

  • Parameters

    • block: function | Promise<any>
    • error: RegExp | Function | Object | Error
    • Optional message: string | Error

    Returns Promise<void>

strictEqual

  • strictEqual(actual: any, expected: any, message?: string | Error): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string | Error

    Returns void

throws

  • throws(block: function, message?: string | Error): void
  • throws(block: function, error: RegExp | Function | Object | Error, message?: string | Error): void
  • Parameters

    • block: function
        • (): any
        • Returns any

    • Optional message: string | Error

    Returns void

  • Parameters

    • block: function
        • (): any
        • Returns any

    • error: RegExp | Function | Object | Error
    • Optional message: string | Error

    Returns void

Generated using TypeDoc