UncapitalizedString - API reference

API reference › @evolu/common › Type › UncapitalizedString

const UncapitalizedString: uncapitalized(String);

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

Validates uncapitalized text as TypeScript's Uncapitalize<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 uncapitalize to produce an uncapitalized value from any string.

Example

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

const text: UncapitalizedString = "hello WORLD";
assertOk(UncapitalizedString.fromUnknown(text), text);
assertErr(UncapitalizedString.fromUnknown("Hello WORLD"));
assertOk(UncapitalizedString.fromUnknown(""), "");