Skip to content

NonEmptyString

NonEmptyString = string & object

Defined in: src/core/types.ts:39

A string that is guaranteed to be non-empty at the type level.

Use the nonEmpty() helper function to create NonEmptyString values, or cast string literals directly: 'main' as NonEmptyString

Type Declaration

[NonEmptyBrand]

readonly [NonEmptyBrand]: never

Example

// Using helper function (recommended for variables)
const branch = nonEmpty(userInput);
await repo.branch.create(branch);
// Casting literals (safe for known values)
await repo.checkout('main' as NonEmptyString);