defineEvent

defineEvent<TType, TDataObject>(type, dataObjectSchema): EventSchemaDefinition<TType, ZodObject<{ data: ZodObject<{ object: TDataObject; }, $strip>; id: ZodString; type: ZodLiteral<TType>; }, $strip>>

Defined in: zod/src/index.ts:80

Define an event schema for use with createEventMap

Type Parameters

TType

TType extends string

TDataObject

TDataObject extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Parameters

type

TType

The event type string

dataObjectSchema

TDataObject

Zod schema for the data.object property

Returns

EventSchemaDefinition<TType, ZodObject<{ data: ZodObject<{ object: TDataObject; }, $strip>; id: ZodString; type: ZodLiteral<TType>; }, $strip>>

An event schema definition

Example

const issueOpened = defineEvent('issue.opened', z.object({
  id: z.number(),
  title: z.string(),
}));