ts-fortress
    Preparing search index...

    Function string

    • Parameters

      • OptionaldefaultValue: string

      Returns ConstrainedType<
          string,
          Readonly<
              {
                  endsWith: undefined;
                  includes: undefined;
                  lowercase: undefined;
                  maxLength: undefined;
                  minLength: undefined;
                  nonempty: undefined;
                  regex: undefined;
                  startsWith: undefined;
                  uppercase: undefined;
              },
          >,
      >

    • Type Parameters

      • S extends string
      • const C extends Partial<
            Readonly<
                {
                    endsWith: string;
                    includes: string;
                    lowercase: true;
                    maxLength: number;
                    minLength: number;
                    nonempty: true;
                    regex: RegExp;
                    startsWith: string;
                    uppercase: true;
                },
            >,
        >

      Parameters

      • defaultValue: S & DefaultValueWhenNonemptyIsOn<S, C> & DefaultValueWhenMinLengthIsOn<S, C> & DefaultValueWhenMaxLengthIsOn<
            S,
            C,
        > & DefaultValueWhenStartsWithIsOn<C> & DefaultValueWhenEndsWithIsOn<C> & DefaultValueWhenIncludesIsOn<
            C,
        > & DefaultValueWhenUppercaseIsOn<S, C> & DefaultValueWhenLowercaseIsOn<
            S,
            C,
        >
      • constraints: C

      Returns ConstrainedType<
          ConstraintsResultType<C>,
          Readonly<
              {
                  endsWith: "endsWith" extends keyof C
                      ? C[keyof C & "endsWith"]
                      : undefined;
                  includes: "includes" extends keyof C
                      ? C[keyof C & "includes"]
                      : undefined;
                  lowercase: "lowercase" extends keyof C
                      ? C[keyof C & "lowercase"]
                      : undefined;
                  maxLength: "maxLength" extends keyof C
                      ? C[keyof C & "maxLength"]
                      : undefined;
                  minLength: "minLength" extends keyof C
                      ? C[keyof C & "minLength"]
                      : undefined;
                  nonempty: "nonempty" extends keyof C
                      ? C[keyof C & "nonempty"]
                      : undefined;
                  regex: "regex" extends keyof C ? C[keyof C & "regex"] : undefined;
                  startsWith: "startsWith" extends keyof C
                      ? C[keyof C & "startsWith"]
                      : undefined;
                  uppercase: "uppercase" extends keyof C
                      ? C[keyof C & "uppercase"]
                      : undefined;
              },
          >,
      >