Function assertBoolean

  • assertBoolean(value, message?): asserts value is boolean

  • Narrows an unknown value to a boolean if it is type-compatible, or raises an error otherwise.

    Parameters

    • value: unknown

      The value to test.

    • Optionalmessage: string

      The error message to use if value is not type-compatible.

    Returns asserts value is boolean

    Throws

    AssertionFailedError If the value was undefined.

Settings

Member Visibility