Variable asPositiveUint32`Const`

asPositiveUint32: <N extends number>(
    x: N,
) => number & {
    "!=0": true;
    "< 2^32": true;
    "<=0": false;
    "> -2^16": true;
    "> -2^32": true;
    ">= -2^15": true;
    ">= -2^31": true;
    ">=0": true;
    Finite: true;
    Int: true;
    NaNValue: false;
    SafeInt: true;
} & Readonly<
    {
        "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
    },
> & N = castType

Casts a number to the PositiveUint32 branded type.

Validates that the value is a positive integer in [1, 2^32) and returns it with the PositiveUint32 brand. Throws a TypeError otherwise.

Type Declaration

- <N extends number>(
      x: N,
  ): number & {
      "!=0": true;
      "< 2^32": true;
      "<=0": false;
      "> -2^16": true;
      "> -2^32": true;
      ">= -2^15": true;
      ">= -2^31": true;
      ">=0": true;
      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 & {
      "!=0": true;
      "< 2^32": true;
      "<=0": false;
      "> -2^16": true;
      "> -2^32": true;
      ">= -2^15": true;
      ">= -2^31": true;
      ">=0": true;
      Finite: true;
      Int: true;
      NaNValue: false;
      SafeInt: true;
  } & Readonly<
      {
          "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
      },
  > & N
  The value as a PositiveUint32

Throws

If the value is not a positive integer in [1, 2^32)

Variable asPositiveUint32Const

Type Declaration

Type Parameters

Parameters

Returns number & { "!=0": true; "< 2^32": true; "<=0": false; "> -2^16": true; "> -2^32": true; ">= -2^15": true; ">= -2^31": true; ">=0": true; Finite: true; Int: true; NaNValue: false; SafeInt: true;} & Readonly< { "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown; },> & N

Throws

Settings

Variable asPositiveUint32`Const`

Returns number & {
"!=0": true;
"< 2^32": true;
"<=0": false;
"> -2^16": true;
"> -2^32": true;
">= -2^15": true;
">= -2^31": true;
">=0": true;
Finite: true;
Int: true;
NaNValue: false;
SafeInt: true;
} & Readonly<
{
"TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
},
> & N