guardBigInt()

guardBigInt()

Guards the value to be a bigint.

guard-bigint.func.ts

const guardBigInt = <
  BigInt extends bigint,
  Payload extends object = object
>(
  value: BigInt,
  callback?: ResultCallback<BigInt, Payload>,
  payload?: Payload
): value is BigInt => isBigInt(value, callback, payload);

type/src/guard/lib/guard-big-int.func.ts at main · angular-package/typeGitHub

Generic type variables

BigIntextendsbigint

A generic type variable BigInt constrained by the bigint indicates captured bigint type of the given value via the return type and the value parameter of the provided callback function ResultCallback type.

Payloadextendsobject=object

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

Parameters

value: BigInt

A bigint type value to guard.

callback?: ResultCallback<BigInt, Payload>

The optional 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.

Return type

value is BigInt

The return type is a boolean as the result of its statement indicating the value is BigInt.

Returns

The return value is a boolean indicating whether the value is a bigint.

Example usage

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

guardBigInt(1n); // true, value is bigint
guardBigInt(false as any); // false, value is bigint