ksuid

Creates a KSUID validation action.

const Action = v.ksuid<TInput, TMessage>(message);

Generics

• TInput extends string
• TMessage extends ErrorMessage<KsuidIssue<TInput>> | undefined

Parameters

• message TMessage

Explanation

With ksuid you can validate the formatting of a string. If the input is not a KSUID, you can use message to customize the error message.

Returns

• Action KsuidAction<TInput, TMessage>

Examples

The following examples show how ksuid can be used.

KSUID schema

Schema to validate a KSUID.

const KsuidSchema = v.pipe(
  v.string(),
  v.ksuid('The KSUID is badly formatted.')
);

Related

The following APIs can be combined with ksuid.

Schemas

any, custom, string

Methods

pipe

Utils

isOfKind, isOfType