Function: defineEvent()

August 8, 2026 ยท View on GitHub

@plures/praxis


@plures/praxis / index / defineEvent

Function: defineEvent()

defineEvent<TTag, TPayload>(tag): EventDefinition<TTag, TPayload>

Defined in: src/dsl/index.ts:73

Define a typed event

Type Parameters

TTag

TTag extends string

TPayload

TPayload

Parameters

tag

TTag

The event type tag (e.g. "LOGIN") โ€” must be a string literal type for full type safety

Returns

EventDefinition<TTag, TPayload>

An EventDefinition with create() and is() helpers

Example

const Login = defineEvent<"LOGIN", { username: string; password: string }>("LOGIN");
const event = Login.create({ username: "alice", password: "secret" });