ts-fortress
    Preparing search index...

    Function number

    • Parameters

      • OptionaldefaultValue: number

      Returns ConstrainedType<
          number,
          Readonly<
              {
                  finite: undefined;
                  gt: undefined;
                  gte: undefined;
                  int: undefined;
                  lt: undefined;
                  lte: undefined;
                  max: undefined;
                  min: undefined;
                  multipleOf: undefined;
                  negative: undefined;
                  nonNegative: undefined;
                  nonPositive: undefined;
                  nonZero: undefined;
                  positive: undefined;
                  safeInteger: undefined;
                  step: undefined;
              },
          >,
      >

    • Type Parameters

      • N extends number
      • const C extends Partial<
            Readonly<
                {
                    finite: true;
                    gt: number;
                    gte: number;
                    int: true;
                    lt: number;
                    lte: number;
                    max: number;
                    min: number;
                    multipleOf: number;
                    negative: true;
                    nonNegative: true;
                    nonPositive: true;
                    nonZero: true;
                    positive: true;
                    safeInteger: true;
                    step: number;
                },
            >,
        >

      Parameters

      • defaultValue: N & DefaultValueWhenNonZeroIsOn<N, C> & DefaultValueWhenNegativeIsOn<N, C> & DefaultValueWhenNonNegativeIsOn<
            N,
            C,
        > & DefaultValueWhenPositiveIsOn<N, C> & DefaultValueWhenNonPositiveIsOn<
            N,
            C,
        >
      • constraints: C

      Returns ConstrainedType<
          ConstraintsToResultHelperType<ConstraintsToResultBrandKeys<C>>,
          Readonly<
              {
                  finite: "finite" extends keyof C ? C[keyof C & "finite"] : undefined;
                  gt: "gt" extends keyof C ? C[keyof C & "gt"] : undefined;
                  gte: "gte" extends keyof C ? C[keyof C & "gte"] : undefined;
                  int: "int" extends keyof C ? C[keyof C & "int"] : undefined;
                  lt: "lt" extends keyof C ? C[keyof C & "lt"] : undefined;
                  lte: "lte" extends keyof C ? C[keyof C & "lte"] : undefined;
                  max: "max" extends keyof C ? C[keyof C & "max"] : undefined;
                  min: "min" extends keyof C ? C[keyof C & "min"] : undefined;
                  multipleOf: "multipleOf" extends keyof C
                      ? C[keyof C & "multipleOf"]
                      : undefined;
                  negative: "negative" extends keyof C
                      ? C[keyof C & "negative"]
                      : undefined;
                  nonNegative: "nonNegative" extends keyof C
                      ? C[keyof C & "nonNegative"]
                      : undefined;
                  nonPositive: "nonPositive" extends keyof C
                      ? C[keyof C & "nonPositive"]
                      : undefined;
                  nonZero: "nonZero" extends keyof C ? C[keyof C & "nonZero"] : undefined;
                  positive: "positive" extends keyof C
                      ? C[keyof C & "positive"]
                      : undefined;
                  safeInteger: "safeInteger" extends keyof C
                      ? C[keyof C & "safeInteger"]
                      : undefined;
                  step: "step" extends keyof C ? C[keyof C & "step"] : undefined;
              },
          >,
      >