ResultCallback

ResultCallback<Value, Payload>

Represents a callback function with parameters, the value that has been checked, the result of this check, and an optional payload.

result-callback.type.ts

type ResultCallback<Value = any, Payload = object> = (
  result: boolean,
  value: Value,
  payload?: Payload
) => boolean;

Generic type variables

Value=any

A generic type variable Value determines value parameter type, by default any.

Payload=object

Generic type variable Payload indicates payload parameter type, by default object.

Parameters

result: boolean

The check result of a boolean type of the given value.

value: Value

The value of the generic type variable Value to check and which the given check result applies.

payload?: Payload

An optional object of a generic type variable Payload to provide more data.

Returns

The return value is a boolean indicating the check result of the given value.