BlockSuite API Documentation / @blocksuite/store / ReactiveYMap

Class: ReactiveYMap

Defined in: packages/framework/store/src/reactive/proxy.ts:157

Extends

• BaseReactiveYData<UnRecord, YMap<unknown>>

Constructors

new ReactiveYMap()

new ReactiveYMap(_source, _ySource, _options): ReactiveYMap

Defined in: packages/framework/store/src/reactive/proxy.ts:266

Parameters

_source

UnRecord

_ySource

YMap<unknown>

_options

ProxyOptions<UnRecord>

Returns

ReactiveYMap

Overrides

BaseReactiveYData<UnRecord, YMap<unknown>>.constructor

Properties

_options

protected readonly _options: ProxyOptions<UnRecord>

Defined in: packages/framework/store/src/reactive/proxy.ts:269

Inherited from

BaseReactiveYData._options

---

_proxy

protected readonly _proxy: UnRecord

Defined in: packages/framework/store/src/reactive/proxy.ts:263

Overrides

BaseReactiveYData._proxy

---

_skipNext

protected _skipNext: boolean = false

Defined in: packages/framework/store/src/reactive/base-reactive-data.ts:48

Inherited from

BaseReactiveYData._skipNext

---

_source

protected readonly _source: UnRecord

Defined in: packages/framework/store/src/reactive/proxy.ts:267

Inherited from

BaseReactiveYData._source

---

_stashed

protected readonly _stashed: Set<string | number>

Defined in: packages/framework/store/src/reactive/base-reactive-data.ts:52

Inherited from

BaseReactiveYData._stashed

---

_ySource

protected readonly _ySource: YMap<unknown>

Defined in: packages/framework/store/src/reactive/proxy.ts:268

Inherited from

BaseReactiveYData._ySource

Accessors

proxy

Get Signature

get proxy(): T

Defined in: packages/framework/store/src/reactive/base-reactive-data.ts:69

Returns

T

Inherited from

BaseReactiveYData.proxy

Methods

_getOrigin()

protected _getOrigin(doc): object

Defined in: packages/framework/store/src/reactive/base-reactive-data.ts:9

Parameters

doc

Doc

Returns

object

doc

doc: Doc

proxy

proxy: true

target

target: BaseReactiveYData<any, any>

Inherited from

BaseReactiveYData._getOrigin

---

_getProxy()

protected _getProxy(): UnRecord

Defined in: packages/framework/store/src/reactive/proxy.ts:181

Returns

UnRecord

---

_onObserve()

protected _onObserve(event, handler): void

Defined in: packages/framework/store/src/reactive/base-reactive-data.ts:24

Parameters

event

YEvent<any>

handler

() => void

Returns

void

Inherited from

BaseReactiveYData._onObserve

---

_transact()

protected _transact(doc, fn): void

Defined in: packages/framework/store/src/reactive/base-reactive-data.ts:54

Parameters

doc

Doc

fn

() => void

Returns

void

Inherited from

BaseReactiveYData._transact

---

_updateWithSkip()

protected _updateWithSkip(fn): void

Defined in: packages/framework/store/src/reactive/base-reactive-data.ts:58

Parameters

fn

() => void

Returns

void

Inherited from

BaseReactiveYData._updateWithSkip

---

pop()

pop(prop): void

Defined in: packages/framework/store/src/reactive/proxy.ts:278

Parameters

prop

string

Returns

void

Overrides

BaseReactiveYData.pop

---

stash()

stash(prop): void

Defined in: packages/framework/store/src/reactive/proxy.ts:284

Parameters

prop

string

Returns

void

Overrides

BaseReactiveYData.stash