typesafe-ts API Documentation - v1.5.1
    Preparing search index...

    Variable brandConst

    brand: {
        apply: <T extends BrandableTypes, const BrandString extends string>(
            value: T extends Brand<UnderlyingType, ExistingBrand>
                ? TypeAlreadyBrandedError<UnderlyingType, ExistingBrand>
                : T,
            brand_string: BrandString,
        ) => Brand<T, BrandString>;
        symbol: symbol;
        Error: <const BrandString extends string>(
            brand_string: BrandString,
        ) => new <
            ErrorData extends Record<string, unknown> = Record<string, never>,
        >(
            args: [Record<string, never>] extends [ErrorData]
                ? void | { message?: string; cause?: unknown }
                : BrandedErrorCustomData<ErrorData>,
        ) => BrandedErrorType<BrandString, ErrorData>;
    } = ...

    Factory namespace for creating and managing branded types. Provides utilities to apply runtime brands to values, create discriminated error types, and access the brand symbol for type narrowing in union discriminants.

    Type declaration

    • apply: <T extends BrandableTypes, const BrandString extends string>(
          value: T extends Brand<UnderlyingType, ExistingBrand>
              ? TypeAlreadyBrandedError<UnderlyingType, ExistingBrand>
              : T,
          brand_string: BrandString,
      ) => Brand<T, BrandString>

      Applies a runtime brand to a value, creating a nominal type.

    • symbol: symbol

      Unique symbol used to store and access brand identifiers.

    • Error: <const BrandString extends string>(
          brand_string: BrandString,
      ) => new <ErrorData extends Record<string, unknown> = Record<string, never>>(
          args: [Record<string, never>] extends [ErrorData]
              ? void | { message?: string; cause?: unknown }
              : BrandedErrorCustomData<ErrorData>,
      ) => BrandedErrorType<BrandString, ErrorData>

      Creates a branded error class factory for discriminated error handling.