API > @blocksuite/store > Y > YEvent

Class: YEvent<T> ​

Extended By ​

• YXmlEvent
• YMapEvent
• YArrayEvent
• YTextEvent

Constructors ​

constructor ​

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

Type parameters ​

Parameters ​

Returns ​

YEvent< T >

Defined In ​

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

Properties ​

_changes ​

_changes: null | Object

Defined In ​

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

_delta ​

_delta: null | {attributes: {}; delete: number; insert: string | object | any[] | AbstractType< any >; retain: number;}[]

Defined In ​

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

_keys ​

_keys: null | Map< string, {action: "add" | "update" | "delete"; newValue: any; oldValue: any;} >

Defined In ​

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

_path ​

_path: null | (string | number)[]

Defined In ​

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

currentTarget ​

currentTarget: AbstractType< any >

The current target on which the observe callback is called.

Defined In ​

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

target ​

target: T

The type on which this event was created on.

Defined In ​

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

transaction ​

transaction: Transaction

The transaction that triggered this event.

Defined In ​

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

Accessors ​

changes ​

get changes(): object

Defined In ​

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

delta ​

get delta(): {attributes: {}; delete: number; insert: string | object | any[] | AbstractType< any >; retain: number;}[]

Defined In ​

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

keys ​

get keys(): Map< string, {action: "add" | "update" | "delete"; newValue: any; oldValue: any;} >

Defined In ​

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

path ​

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

Defined In ​

node_modules/.pnpm/yjs@13.6.8/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 ​

Returns ​

boolean

Defined In ​

node_modules/.pnpm/yjs@13.6.8/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 ​

Returns ​

boolean

Defined In ​

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