Skip to main content

Interface: DatasetEvents

Defined in: api/dataset-plugin.ts:66

beforeChange/change, the two events a Dataset raises. Returning false from a beforeChange handler vetoes the whole changeset — the refusal path a lock plugin uses.

Methods​

off()​

off<K>(name, handler): void

Defined in: api/dataset-plugin.ts:75

Type Parameters​

K​

K extends keyof DatasetEventMap

Parameters​

name​

K

handler​

(payload) => false | void

Returns​

void


on()​

on<K>(name, handler): Disposer

Defined in: api/dataset-plugin.ts:71

Every plugin registration seam returns a Disposer that removes exactly its own registration (I2); on is that seam for a Dataset event. Not gated — a plugin may call this after its own data() returns — but still tracked: the handler is removed when the plugin is uninstalled or the Dataset is destroyed, the same as every other seam.

Type Parameters​

K​

K extends keyof DatasetEventMap

Parameters​

name​

K

handler​

(payload) => false | void

Returns​

Disposer