Class AssertState

constructor

• new AssertState(value, pathPart?, parent?): $.AssertState

• Parameters

  • value: unknown
  • OptionalpathPart: string
  • Optionalparent: $.AssertState

  Returns $.AssertState

Optionalparent

pathPart

value

path

• get path(): string

• Returns string

bigint

• bigint(shape, min, max): void

• Parameters

  • shape: $.AnyShape
  • min: bigint
  • max: bigint

  Returns void

equals

• equals(shape, value, label?): void

• Parameters

  • shape: $.AnyShape
  • value: unknown
  • Optionallabel: string

  Returns void

instanceof

• instanceof(shape, ctor): void

• Parameters

  • shape: $.AnyShape
  • ctor: (new (...args: any) => unknown)
    • • new (...args): unknown

      • Parameters

        • Rest...args: any

        Returns unknown

  Returns void

integer

• integer(shape, min, max): void

• Parameters

  • shape: $.AnyShape
  • min: number
  • max: number

  Returns void

key

• key(shape, key): $.AssertState

• Parameters

  • shape: $.AnyShape
  • key: string | number | symbol

  Returns $.AssertState

nonNull

• nonNull(shape): void

• Parameters

  • shape: $.AnyShape

  Returns void

typeof

• typeof<K>(shape, type): void

• Type Parameters

  • K extends keyof TypeofMap

  Parameters

  • shape: $.AnyShape
  • type: K

  Returns void