ulid
Creates an ULID validation action.
const Action = v.ulid<TInput, TMessage>(message);
Generics
TInputextends stringTMessageextends ErrorMessage<UlidIssue<TInput>> | undefined
Parameters
messageTMessage
Explanation
With ulid you can validate the formatting of a string. If the input is not an ULID, you can use message to customize the error message.
Returns
ActionUlidAction<TInput, TMessage>
Examples
The following examples show how ulid can be used.
ULID schema
Schema to validate an ULID.
const UlidSchema = v.pipe(v.string(), v.ulid('The ULID is badly formatted.'));
Related
The following APIs can be combined with ulid.