Options
All
  • Public
  • Public/Protected
  • All
Menu

Module assert/callback

Index

Type aliases

CallbackArgument<ValueType, Arguments>: { error: any } & Partial<default>

Type parameters

  • ValueType

  • Arguments: unknown[] = unknown[]

Functions

  • CallbackParameter<ValueType, Arguments>(value: ValueType, __namedParameters: { error: any } & Partial<default<unknown[]>> & default<[ValueType, ...Arguments[]], boolean>): void
  • CallbackParameter<ValueType, Match, Arguments>(value: ValueType, __namedParameters: { error: any } & Partial<default<unknown[]>> & default<ValueType, Match, Arguments>): asserts value is Match
  • Type parameters

    • ValueType

    • Arguments: unknown[] = unknown[]

    Parameters

    • value: ValueType
    • __namedParameters: { error: any } & Partial<default<unknown[]>> & default<[ValueType, ...Arguments[]], boolean>

    Returns void

  • Type parameters

    • ValueType

    • Match

    • Arguments: unknown[] = unknown[]

    Parameters

    • value: ValueType
    • __namedParameters: { error: any } & Partial<default<unknown[]>> & default<ValueType, Match, Arguments>

    Returns asserts value is Match

  • CallbackParameters<ValueType, Match, Arguments>(value: ValueType, validation: (value: ValueType, ...args: Arguments) => value is Match, error: (value: ValueType, ...args: Arguments) => Error, ...argument: Arguments): asserts value is Match
  • CallbackParameters<ValueType, Arguments>(value: ValueType, validation: (value: ValueType, ...args: Arguments) => boolean, error: (value: ValueType, ...args: Arguments) => Error, ...argument: Arguments): void
  • Throw exception from {@param error} if given {@param value} is not valid according to {@param validation}

    This can be use to create type assertion

    Type parameters

    • ValueType

    • Match

    • Arguments: unknown[] = unknown[]

    Parameters

    • value: ValueType
    • validation: (value: ValueType, ...args: Arguments) => value is Match
        • (value: ValueType, ...args: Arguments): value is Match
        • Parameters

          • value: ValueType
          • Rest ...args: Arguments

          Returns value is Match

    • error: (value: ValueType, ...args: Arguments) => Error
        • (value: ValueType, ...args: Arguments): Error
        • Parameters

          • value: ValueType
          • Rest ...args: Arguments

          Returns Error

    • Rest ...argument: Arguments

    Returns asserts value is Match

  • Type parameters

    • ValueType

    • Arguments: unknown[] = unknown[]

    Parameters

    • value: ValueType
    • validation: (value: ValueType, ...args: Arguments) => boolean
        • (value: ValueType, ...args: Arguments): boolean
        • Parameters

          • value: ValueType
          • Rest ...args: Arguments

          Returns boolean

    • error: (value: ValueType, ...args: Arguments) => Error
        • (value: ValueType, ...args: Arguments): Error
        • Parameters

          • value: ValueType
          • Rest ...args: Arguments

          Returns Error

    • Rest ...argument: Arguments

    Returns void

Generated using TypeDoc