maxLength - API reference

API reference › @evolu/common › Type › maxLength

function maxLength<Max extends number>(
  max: ValidateBrandFactoryCount<Max>,
): BrandFactory<`MaxLength${Max}`, ValueWithLength, MaxLengthError<Max>>;

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

Maximum-length Brand for values whose length is at most max.

Example

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

const AtMostThreeCharacters = maxLength(3)(String);
const AtMostTwoItems = maxLength(2)(array(String));

assertOk(AtMostThreeCharacters.fromUnknown("abc"), "abc");
assertOk(AtMostTwoItems.fromUnknown(["a", "b"]), ["a", "b"]);