Function assertPlainObject

  • assertPlainObject<T>(value, message?): asserts value is T

  • Narrows an unknown value to an object if it is type-compatible and tests positively with isPlainObject, or raises an error otherwise.

    Type Parameters

    • T extends object = object

    Parameters

    • value: unknown

      The value to test.

    • Optionalmessage: string

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

    Returns asserts value is T

    Throws

    AssertionFailedError If the value was undefined.

Settings

Member Visibility