Skip to main content

Function: literal()

Call Signature​

literal<T>(value, params?): ZodLiteral<T[number]>

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

Type Parameters​

T​

T extends readonly Literal[]

Parameters​

value​

T

params?​

string |

{ error?: string | $ZodErrorMap<$ZodIssueInvalidValue<unknown>>; message?: string; }

error?​

string | $ZodErrorMap<$ZodIssueInvalidValue<unknown>>

message?​

string

Deprecated

This parameter is deprecated. Use error instead.

Returns​

ZodLiteral<T[number]>

Call Signature​

literal<T>(value, params?): ZodLiteral<T>

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

Type Parameters​

T​

T extends Literal

Parameters​

value​

T

params?​

string |

{ error?: string | $ZodErrorMap<$ZodIssueInvalidValue<unknown>>; message?: string; }

error?​

string | $ZodErrorMap<$ZodIssueInvalidValue<unknown>>

message?​

string

Deprecated

This parameter is deprecated. Use error instead.

Returns​

ZodLiteral<T>