Skip to main content

Function: cuid()

cuid(params?): ZodCUID

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:249

Validates a CUID v1 string.

Parameters​

params?​

string |

{ abort?: boolean; error?: string | $ZodErrorMap<NonNullable<$ZodIssueInvalidType<unknown> | $ZodIssueInvalidStringFormat>>; message?: string; pattern?: RegExp; }

abort?​

boolean

If true, no later checks will be executed if this check fails. Default false.

error?​

string | $ZodErrorMap<NonNullable<$ZodIssueInvalidType<unknown> | $ZodIssueInvalidStringFormat>>

message?​

string

Deprecated

This parameter is deprecated. Use error instead.

pattern?​

RegExp

Returns​

ZodCUID

Deprecated​

CUID v1 is deprecated by its authors due to information leakage (timestamps embedded in the id). Use `z.cuid2()` instead. See https://github.com/paralleldrive/cuid.