SchemaRegistry
Defined in: zod/src/index.ts:119
Schema registry for runtime validation
Type Parameters
Section titled “Type Parameters”TEventMap
Section titled “TEventMap”TEventMap extends Record<string, WebhookEvent> = Record<string, WebhookEvent>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SchemaRegistry<
TEventMap>(options?):SchemaRegistry<TEventMap>
Defined in: zod/src/index.ts:123
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”SchemaRegistry<TEventMap>
Methods
Section titled “Methods”get(
type):ZodType<unknown,unknown,$ZodTypeInternals<unknown,unknown>> |undefined
Defined in: zod/src/index.ts:160
Get the schema for an event type
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | undefined
has(
type):boolean
Defined in: zod/src/index.ts:167
Check if a schema exists for an event type
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
register()
Section titled “register()”register<
TType>(type,schema):this
Defined in: zod/src/index.ts:132
Register a schema for an event type
Type Parameters
Section titled “Type Parameters”TType extends string
Parameters
Section titled “Parameters”TType
schema
Section titled “schema”ZodType
Returns
Section titled “Returns”this
Throws
Section titled “Throws”Error if a schema already exists for this type and strict mode is enabled
registerAll()
Section titled “registerAll()”registerAll(
definitions):this
Defined in: zod/src/index.ts:150
Register multiple event definitions
Parameters
Section titled “Parameters”definitions
Section titled “definitions”Record<string, EventSchemaDefinition>
Returns
Section titled “Returns”this
safeParse()
Section titled “safeParse()”safeParse(
event):SafeParseResult<WebhookEvent>
Defined in: zod/src/index.ts:187
Safely validate an event, returning a result object
Parameters
Section titled “Parameters”Returns
Section titled “Returns”validate()
Section titled “validate()”validate(
event):WebhookEvent
Defined in: zod/src/index.ts:176
Validate an event against its registered schema
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Throws
Section titled “Throws”ZodError if validation fails