Name - API reference

API reference › @evolu/common › Type › Name

const Name: brand("Name", UrlSafeString, (value) =>
  value.length >= 1 && value.length <= 64
    ? ok(value)
    : err<NameError>({ type: "Name", value }),
);

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

Alphanumeric string for naming in file systems, URLs, and identifiers.

Uses the same safe alphabet as UrlSafeString (letters, digits, -, _).

The string must be between 1 and 64 characters.

Example

const result = Name.from("data-report-123");
if (result.ok) {
  console.log("Valid Name string:", result.value);
} else {
  console.error("Invalid Name string:", result.error);
}