BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/store / ReactiveYArray

Class: ReactiveYArray ​

Extends ​

Constructors ​

new ReactiveYArray(_source, _ySource, _options) ​

new ReactiveYArray(_source, _ySource, _options): ReactiveYArray

Parameters ​

• _source: unknown[]

• _ySource: Array<unknown>

• _options: ProxyOptions<unknown[]>

Returns ​

ReactiveYArray

Overrides ​

@blocksuite/store.BaseReactiveYData.constructor

Source ​

packages/framework/store/src/reactive/proxy.ts:21

Properties ​

_options ​

protected readonly _options: ProxyOptions<unknown[]>

Inherited from ​

@blocksuite/store.BaseReactiveYData._options

Source ​

packages/framework/store/src/reactive/proxy.ts:24

_proxy ​

protected readonly _proxy: unknown[]

Overrides ​

@blocksuite/store.BaseReactiveYData._proxy

Source ​

packages/framework/store/src/reactive/proxy.ts:20

_skipNext ​

protected _skipNext: boolean = false

Inherited from ​

@blocksuite/store.BaseReactiveYData._skipNext

Source ​

packages/framework/store/src/reactive/utils.ts:104

_source ​

protected readonly _source: unknown[]

Inherited from ​

@blocksuite/store.BaseReactiveYData._source

Source ​

packages/framework/store/src/reactive/proxy.ts:22

_stashed ​

protected readonly _stashed: Set<string | number>

Inherited from ​

@blocksuite/store.BaseReactiveYData._stashed

Source ​

packages/framework/store/src/reactive/utils.ts:106

_ySource ​

protected readonly _ySource: Array<unknown>

Inherited from ​

@blocksuite/store.BaseReactiveYData._ySource

Source ​

packages/framework/store/src/reactive/proxy.ts:23

Accessors ​

proxy ​

get proxy(): T

Returns ​

T

Source ​

packages/framework/store/src/reactive/utils.ts:111

Methods ​

_getOrigin() ​

protected _getOrigin(doc): Object

Parameters ​

• doc: Doc

Returns ​

Object

doc ​

doc: Doc

proxy ​

proxy: true

target ​

target: BaseReactiveYData<any, any>

Inherited from ​

@blocksuite/store.BaseReactiveYData._getOrigin

Source ​

packages/framework/store/src/reactive/utils.ts:115

_getProxy() ​

protected _getProxy(): unknown[]

Returns ​

unknown[]

Overrides ​

@blocksuite/store.BaseReactiveYData._getProxy

Source ​

packages/framework/store/src/reactive/proxy.ts:42

_observer() ​

private _observer(event): void

Parameters ​

• event: YArrayEvent<unknown>

Returns ​

void

Source ​

packages/framework/store/src/reactive/proxy.ts:104

_onObserve() ​

protected _onObserve(event, handler): void

Parameters ​

• event: YEvent<any>

• handler: () => void

Returns ​

void

Inherited from ​

@blocksuite/store.BaseReactiveYData._onObserve

Source ​

packages/framework/store/src/reactive/utils.ts:141

_transact() ​

protected _transact(doc, fn): void

Parameters ​

• doc: Doc

• fn: () => void

Returns ​

void

Inherited from ​

@blocksuite/store.BaseReactiveYData._transact

Source ​

packages/framework/store/src/reactive/utils.ts:136

_updateWithSkip() ​

protected _updateWithSkip(fn): void

Parameters ​

• fn: () => void

Returns ​

void

Inherited from ​

@blocksuite/store.BaseReactiveYData._updateWithSkip

Source ​

packages/framework/store/src/reactive/utils.ts:130

pop() ​

pop(prop): void

Parameters ​

• prop: number

Returns ​

void

Overrides ​

@blocksuite/store.BaseReactiveYData.pop

Source ​

packages/framework/store/src/reactive/proxy.ts:36

stash() ​

stash(prop): void

Parameters ​

• prop: number

Returns ​

void

Overrides ​

@blocksuite/store.BaseReactiveYData.stash

Source ​

packages/framework/store/src/reactive/proxy.ts:32

Generated using TypeDoc and typedoc-plugin-markdown.

Copyright © 2022-present Toeverything