length - API reference

API reference › @evolu/common › Type › length

function length<Exact>(
  exact: ValidateBrandFactoryNumber<Exact>,
): BrandFactory<`Length${Exact}`, ValueWithLength, LengthError<Exact>>;

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

Exact-length Brand for values whose length equals exact.

Example

import { assertOk, String, array, length } from "@evolu/common";

const ThreeCharacters = length(3)(String);
const TwoItems = length(2)(array(String));

assertOk(ThreeCharacters.fromUnknown("abc"), "abc");
assertOk(TwoItems.fromUnknown(["a", "b"]), ["a", "b"]);