BlockSuite API Documentation / @blocksuite/store / ReactiveYArray

Class: ReactiveYArray

Extends

• BaseReactiveYData<unknown[], YArray<unknown>>

Constructors

new ReactiveYArray()

new ReactiveYArray(_source, _ySource, _options): ReactiveYArray

Parameters

_source

unknown[]

_ySource

YArray<unknown>

_options

ProxyOptions<unknown[]>

Returns

ReactiveYArray

Overrides

BaseReactiveYData.constructor

Defined in

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

Properties

_options

protected readonly _options: ProxyOptions<unknown[]>

Inherited from

BaseReactiveYData._options

Defined in

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

---

_proxy

protected readonly _proxy: unknown[]

Overrides

BaseReactiveYData._proxy

Defined in

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

---

_skipNext

protected _skipNext: boolean = false

Inherited from

BaseReactiveYData._skipNext

Defined in

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

---

_source

protected readonly _source: unknown[]

Inherited from

BaseReactiveYData._source

Defined in

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

---

_stashed

protected readonly _stashed: Set<string | number>

Inherited from

BaseReactiveYData._stashed

Defined in

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

---

_ySource

protected readonly _ySource: YArray<unknown>

Inherited from

BaseReactiveYData._ySource

Defined in

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

Accessors

proxy

Get Signature

get proxy(): T

Returns

T

Inherited from

BaseReactiveYData.proxy

Defined in

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

Methods

_getOrigin()

protected _getOrigin(doc): object

Parameters

doc

Doc

Returns

object

doc

doc: Doc

proxy

proxy: true

target

target: BaseReactiveYData<any, any>

Inherited from

BaseReactiveYData._getOrigin

Defined in

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

---

_getProxy()

protected _getProxy(): unknown[]

Returns

unknown[]

Overrides

BaseReactiveYData._getProxy

Defined in

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

---

_onObserve()

protected _onObserve(event, handler): void

Parameters

event

YEvent<any>

handler

() => void

Returns

void

Inherited from

BaseReactiveYData._onObserve

Defined in

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

---

_transact()

protected _transact(doc, fn): void

Parameters

doc

Doc

fn

() => void

Returns

void

Inherited from

BaseReactiveYData._transact

Defined in

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

---

_updateWithSkip()

protected _updateWithSkip(fn): void

Parameters

fn

() => void

Returns

void

Inherited from

BaseReactiveYData._updateWithSkip

Defined in

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

---

pop()

pop(prop): void

Parameters

prop

number

Returns

void

Overrides

BaseReactiveYData.pop

Defined in

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

---

stash()

stash(prop): void

Parameters

prop

number

Returns

void

Overrides

BaseReactiveYData.stash

Defined in

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