capitalized - API reference

API reference › @evolu/common › Type › capitalized

const capitalized: BrandFactory<"Capitalized", string, CapitalizedError>;

Defined in: packages/common/src/Type.ts:5303

Capitalized Brand.

Requires the first character of a string to be uppercase.

Example

import {
  assertEqual,
  assertErr,
  assertOk,
  assertType,
  Data,
  String,
  capitalized,
  type Brand,
} from "@evolu/common";

const CapitalizedString = capitalized(String);
type CapitalizedString = typeof CapitalizedString.Output;

assertType<string & Brand<"Capitalized">, CapitalizedString>();

assertOk(CapitalizedString.fromUnknown("Evolu"), "Evolu");
const invalid = CapitalizedString.fromUnknown("evolu");
assertErr(invalid);
assertType(Data, invalid.error);
assertEqual(invalid.error, {
  type: "Capitalized",
  value: "evolu",
});