API reference › @evolu/common › Type › CapitalizedString

const CapitalizedString: capitalized(String);

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

Validates capitalized text as TypeScript's Capitalize<string>.

The rest of the text can use any casing. Empty strings and text starting with an uncased character, such as a digit or emoji, are valid. Use capitalize to produce a capitalized value from any string.

Capitalization applies to general text, including spaces and punctuation. Both hello and Hello become Hello, so the original initial casing cannot be recovered. Capitalization does not identify words or turn text into an identifier.

Example

import { assertErr, assertOk, CapitalizedString } from "@evolu/common";

const text: CapitalizedString = "Hello world";
assertOk(CapitalizedString.fromUnknown(text), text);
assertErr(CapitalizedString.fromUnknown("hello world"));
assertOk(CapitalizedString.fromUnknown(""), "");