ts-data-forge
    Preparing search index...

    Variable asPositiveIntConst

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

    Casts a number to the PositiveInt branded type.

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

    Type Declaration

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

      • Type Parameters

        • N extends number

        Parameters

        • x: N

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

        The value as a PositiveInt

    const branded = asPositiveInt(7);

    assert.isTrue(branded === 7);

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

    If the value is not a positive integer

    Settings
    Member Visibility