Function assert

typeof

equal

• equal<T>(actual, expected, details?, errConstructor?, options?): asserts actual is T

• The assert.equal method

  Assert that two values must be Object.is.

  Type Parameters

  • T

  Parameters

  • actual: unknown

    What we received
  • expected: T

    What we wanted
  • Optionaldetails: Details

    The details of what was asserted
  • OptionalerrConstructor: GenericErrorConstructor

    An optional alternate error constructor to use
  • Optionaloptions: AssertMakeErrorOptions

  Returns asserts actual is T

fail

• fail(details?, errConstructor?, options?): never

• The assert.fail method.

  Fail an assertion, recording full details to the console and raising an exception with a message in which details substitution values have been redacted.

  The optional optDetails can be a string for backwards compatibility with the nodejs assertion library.

  Parameters

  • Optionaldetails: Details

    The details of what was asserted
  • OptionalerrConstructor: GenericErrorConstructor

    An optional alternate error constructor to use
  • Optionaloptions: AssertMakeErrorOptions

  Returns never

string

• string(specimen, details?): asserts specimen is string

• The assert.string method.

  assert.string(v) is equivalent to assert.typeof(v, 'string'). We special case this one because it is the most frequently used.

  Assert an expected typeof result.

  Parameters

  • specimen: any
  • Optionaldetails: Details

    The details of what was asserted

  Returns asserts specimen is string