Options
All
  • Public
  • Public/Protected
  • All
Menu

Callable

  • assert(value: any, message?: string | Error): assertsvalue
  • An alias of assert.ok().

    Parameters

    • value: any
    • Optional message: string | Error

    Returns assertsvalue

Index

Type aliases

AssertPredicate

AssertPredicate: RegExp | object | function | object | Error

Variables

Const strict

strict: Omit<assert, "equal" | "notEqual" | "deepEqual" | "notDeepEqual" | "ok" | "strictEqual" | "deepStrictEqual" | "ifError" | "strict"> & object

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<T>(actual: any, expected: T, message?: string | Error): assertsactual is T
  • Type parameters

    • T

    Parameters

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

    Returns assertsactual is T

doesNotMatch

  • doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void
  • Parameters

    • value: string
    • regExp: RegExp
    • Optional message: string | Error

    Returns void

doesNotReject

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

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

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

doesNotThrow

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

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

    • Optional message: string | Error

    Returns void

  • Parameters

    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?: 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: string
    • Optional stackStartFn: Function

    Returns never

ifError

  • ifError(value: any): assertsvalue is null | undefined
  • Parameters

    • value: any

    Returns assertsvalue is null | undefined

match

  • match(value: string, regExp: RegExp, message?: string | Error): void
  • Parameters

    • value: string
    • regExp: RegExp
    • Optional message: string | Error

    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): assertsvalue
  • Parameters

    • value: any
    • Optional message: string | Error

    Returns assertsvalue

rejects

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

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

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

strictEqual

  • strictEqual<T>(actual: any, expected: T, message?: string | Error): assertsactual is T
  • Type parameters

    • T

    Parameters

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

    Returns assertsactual is T

throws

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

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

    • Optional message: string | Error

    Returns void

  • Parameters

    Returns void

Generated using TypeDoc