Options
All
  • Public
  • Public/Protected
  • All
Menu

Module ensure/callback

Index

Namespaces

Type aliases

Functions

Type aliases

CallbackArgument

CallbackArgument<Return, ValueType, ExtraArgument>: Validation<[ValueType, ...ExtraArgument], boolean> & { error: any } & default<ExtraArgument> & Value<ValueType>

Type parameters

  • Return: ValueType

  • ValueType

  • ExtraArgument: unknown[] = unknown[]

Functions

CallbackParameter

  • CallbackParameter<Return, Value, ExtraArgument>(__namedParameters: CallbackArgument<Return, Value, ExtraArgument>): Value

  • object destructure version

    Type parameters

    • Return

    • Value

    • ExtraArgument: unknown[] = unknown[]

    Parameters

    Returns Value

CallbackParameters

  • CallbackParameters<Return, ValueType, ExtraArgument>(value: ValueType, validation: (value: ValueType, ...args: ExtraArgument) => boolean, error: (value: ValueType, ...args: ExtraArgument) => Error, ...argument: ExtraArgument): Return

  • 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

    • Return

    • ValueType

    • ExtraArgument: unknown[] = unknown[]

    Parameters

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

        • Parameters

          • value: ValueType
          • Rest ...args: ExtraArgument

          Returns boolean

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

        • Parameters

          • value: ValueType
          • Rest ...args: ExtraArgument

          Returns Error

    • Rest ...argument: ExtraArgument

      extra argument for both {@param argument} & {@param error}

    Returns Return

Generated using TypeDoc