Skip to content
RelKit
Esc
↑↓navigate↵open⌘Jpreview
On this page

Events API

Generated public TypeScript reference for relkit/events.

Common APIs

For configuration and examples, read events, domains, organization.

For a complete workflow, follow react to order events.

Most-used APIs

These entries carry each API’s contract and example. The complete reference follows.

defineEvent

Defines a versioned event contract used by publishers and event functions.

Throws

TypeError when the contract is malformed.

Example

import { defineEvent } from "relkit/events";
import { z } from "relkit/schema";

const