BlockSuite API Documentation / @blocksuite/store / ReactiveYMap

Class: ReactiveYMap

Extends

• BaseReactiveYData<UnRecord, Map<unknown>>

Constructors

new ReactiveYMap(_source, _ySource, _options)

new ReactiveYMap(_source, _ySource, _options): ReactiveYMap

Parameters

• _source: UnRecord

• _ySource: Map<unknown>

• _options: ProxyOptions<UnRecord>

Returns

ReactiveYMap

Overrides

BaseReactiveYData.constructor

Source

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

Properties

_options

protected readonly _options: ProxyOptions<UnRecord>

Inherited from

BaseReactiveYData._options

Source

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

---

_proxy

protected readonly _proxy: UnRecord

Overrides

BaseReactiveYData._proxy

Source

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

---

_skipNext

protected _skipNext: boolean = false

Inherited from

BaseReactiveYData._skipNext

Source

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

---

_source

protected readonly _source: UnRecord

Inherited from

BaseReactiveYData._source

Source

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

---

_stashed

protected readonly _stashed: Set<string | number>

Inherited from

BaseReactiveYData._stashed

Source

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

---

_ySource

protected readonly _ySource: Map<unknown>

Inherited from

BaseReactiveYData._ySource

Source

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

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

BaseReactiveYData._getOrigin

Source

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

---

_getProxy()

protected _getProxy(): UnRecord

Returns

UnRecord

Overrides

BaseReactiveYData._getProxy

Source

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

---

_observer()

private _observer(event): void

Parameters

• event: YMapEvent<unknown>

Returns

void

Source

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

---

_onObserve()

protected _onObserve(event, handler): void

Parameters

• event: YEvent<any>

• handler

Returns

void

Inherited from

BaseReactiveYData._onObserve

Source

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

---

_transact()

protected _transact(doc, fn): void

Parameters

• doc: Doc

• fn

Returns

void

Inherited from

BaseReactiveYData._transact

Source

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

---

_updateWithSkip()

protected _updateWithSkip(fn): void

Parameters

• fn

Returns

void

Inherited from

BaseReactiveYData._updateWithSkip

Source

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

---

pop()

pop(prop): void

Parameters

• prop: string

Returns

void

Overrides

BaseReactiveYData.pop

Source

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

---

stash()

stash(prop): void

Parameters

• prop: string

Returns

void

Overrides

BaseReactiveYData.stash

Source

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