Event

type Event<TPayload, TFilter> = {
  check: (context) => boolean;
  description: string;
  filter: TFilter;
  id: string;
  name: string;
  payload: TPayload;
};

Defined in: core/src/event/event.types.ts:20

A registered kind of event: its payload schema, a filter schema, and a check predicate deciding whether an occurrence matches a subscriber’s filter.

Type Parameters

Type Parameter	Default type
TPayload extends z.ZodType	z.ZodType
TFilter extends z.ZodType	z.ZodType

Properties

check

check: (context) => boolean;

Defined in: core/src/event/event.types.ts:26

Parameters

Parameter	Type
context	EventCheckContext<TPayload, TFilter>

Returns

boolean

---

description

description: string;

Defined in: core/src/event/event.types.ts:23

---

filter

filter: TFilter;

Defined in: core/src/event/event.types.ts:25

---

id

id: string;

Defined in: core/src/event/event.types.ts:21

---

name

name: string;

Defined in: core/src/event/event.types.ts:22

---

payload

payload: TPayload;

Defined in: core/src/event/event.types.ts:24