every()

areDeterminer().every()

Checks whether every of the provided values pass the test implemented by the given checkFn function.

are-determiner.func.ts

{
  every: <Payload extends CommonPayload>(
    callback: ResultCallback<any, Payload> = resultCallback,
    payload?: Payload
  ): boolean =>
    callback(
      values.every((value) => checkFn(value)),
      values,
      payload
    ),
}

Generic type variables

PayloadextendsCommonPayload

The Payload generic type variable constrained by the generic type variable CommonPayload indicates the type of optional parameter payload of the supplied callback function and payload optional parameter of the areDeterminer().every() method from which it captures its value.

Parameters

callback: ResultCallback<any, Payload>

A callback function of ResultCallback type with parameters, the value that has been checked, the result of this check, and payload of generic type variable Payload with optional properties from the provided payload, to handle them before the result return. By default, it uses resultCallback() function.

payload?: Payload

An optional object of the generic type variable Payload is assigned to the payload of the given callback function.

Returns

The return value is a boolean indicating whether the provided values passed the test implemented by the given checkFn function.

Example usage

// Example usage.
import { areDeterminer } from '@angular-package/type';