Variable asSafeInt`Const`

asSafeInt: <N extends number>(
    x: N,
) => number & { Finite: true; Int: true; NaNValue: false; SafeInt: true } & Readonly<
    {
        "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
    },
> & N = castType

Casts a number to the SafeInt branded type.

Validates that the value is a safe integer and returns it with the SafeInt brand. Throws a TypeError otherwise.

Type Declaration

- <N extends number>(
      x: N,
  ): number & { Finite: true; Int: true; NaNValue: false; SafeInt: true } & Readonly<
      {
          "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
      },
  > & N
- Type Parameters
  - N extends number
  Parameters
  - x: N
  Returns number & { Finite: true; Int: true; NaNValue: false; SafeInt: true } & Readonly<
      {
          "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
      },
  > & N
  The value as a SafeInt

Example

const branded = asSafeInt(123);

assert.isTrue(branded === 123);

assert.isTrue(SafeInt.is(branded));

Throws

If the value is not a safe integer

Variable asSafeIntConst

Type Declaration

Type Parameters

Parameters

Returns number & { Finite: true; Int: true; NaNValue: false; SafeInt: true } & Readonly< { "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown; },> & N

Example

Throws

Settings

Variable asSafeInt`Const`

Returns number & { Finite: true; Int: true; NaNValue: false; SafeInt: true } & Readonly<
{
"TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
},
> & N