Skip to content

BlockSuite API Documentation / @blocksuite/store / Y / YEvent

Class: YEvent<T>

Extended by

Type parameters

T extends AbstractType<any>

YEvent describes the changes on a YType.

Constructors

new YEvent(target, transaction)

new YEvent<T>(target, transaction): YEvent<T>

Parameters

target: T

The changed type.

transaction: Transaction

Returns

YEvent<T>

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:10

Properties

_changes

_changes: null | Object

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:29


_delta

_delta: null | Object[]

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:41


_keys

_keys: null | Map<string, Object>

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:33


_path

_path: null | (string | number)[]

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:52


currentTarget

currentTarget: AbstractType<any>

The current target on which the observe callback is called.

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:20


target

target: T

The type on which this event was created on.

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:15


transaction

transaction: Transaction

The transaction that triggered this event.

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:25

Accessors

changes

get changes(): Object

This is a computed property. Note that this can only be safely computed during the event call. Computing this property after other changes happened might result in unexpected behavior (incorrect computation of deltas). A safe way to collect changes is to store the changes or the delta object. Avoid storing the transaction object.

Returns

Object

added

added: Set<Item>

deleted

deleted: Set<Item>

delta

delta: Object[]

keys

keys: Map<string, Object>

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:117


delta

get delta(): Object[]

This is a computed property. Note that this can only be safely computed during the event call. Computing this property after other changes happened might result in unexpected behavior (incorrect computation of deltas). A safe way to collect changes is to store the changes or the delta object. Avoid storing the transaction object.

Returns

Object[]

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:92


keys

get keys(): Map<string, Object>

Returns

Map<string, Object>

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:79


path

get path(): (string | number)[]

Computes the path from y to the changed type.

Todo

v14 should standardize on path: Array<\{parent, index\}> because that is easier to work with.

The following property holds:

Example

ts
let type = y
  event.path.forEach(dir => {
    type = type.get(dir)
  })
  type === event.target // => true

Returns

(string | number)[]

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:66

Methods

adds()

adds(struct): boolean

Check if a struct is added by this event.

In contrast to change.deleted, this method also returns true if the struct was added and then deleted.

Parameters

struct: AbstractStruct

Returns

boolean

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:108


deletes()

deletes(struct): boolean

Check if a struct is deleted by this event.

In contrast to change.deleted, this method also returns true if the struct was added and then deleted.

Parameters

struct: AbstractStruct

Returns

boolean

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/utils/YEvent.d.ts:75