EventHelpers
EventHelpers<
R> =object
Defined in: packages/schema/src/events/event-helpers.ts:106
The e of .events((e, r) => [...]). Options combine with AND.
Type Parameters
Section titled “Type Parameters”R
Methods
Section titled “Methods”becomes()
Section titled “becomes()”becomes(
name,condition):EventSpec
Defined in: packages/schema/src/events/event-helpers.ts:116
Fires when condition turns true: on a create that meets it, or an update after which it holds and before which it did not.
Parameters
Section titled “Parameters”string
condition
Section titled “condition”string
Returns
Section titled “Returns”created()
Section titled “created()”created(
name?,options?):EventSpec
Defined in: packages/schema/src/events/event-helpers.ts:108
Fires when a record is created; named created unless name says otherwise.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”crud()
Section titled “crud()”crud():
EventSpec[]
Defined in: packages/schema/src/events/event-helpers.ts:118
created, updated and deleted, plus undeleted when the resource soft deletes.
Returns
Section titled “Returns”deleted()
Section titled “deleted()”deleted(
name?,options?):EventSpec
Defined in: packages/schema/src/events/event-helpers.ts:112
Fires when a record is deleted, soft deletes included; named deleted unless name says otherwise.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”undeleted()
Section titled “undeleted()”undeleted(
name?,options?):EventSpec
Defined in: packages/schema/src/events/event-helpers.ts:114
Fires when a soft deleted record is restored; named undeleted unless name says otherwise.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”updated()
Section titled “updated()”updated(
name?,options?):EventSpec
Defined in: packages/schema/src/events/event-helpers.ts:110
Fires when a record is updated; named updated unless name says otherwise.
Parameters
Section titled “Parameters”string