BlockSuite API Documentation / @blocksuite/store / Boxed

Class: Boxed<T>

Defined in: packages/framework/store/src/reactive/boxed.ts:7

Type Parameters

T

T = unknown

Constructors

new Boxed()

new Boxed<T>(value, onChange?): Boxed<T>

Defined in: packages/framework/store/src/reactive/boxed.ts:34

Parameters

value

T

onChange?

OnBoxedChange

Returns

Boxed<T>

Accessors

yMap

Get Signature

get yMap(): YMap<T>

Defined in: packages/framework/store/src/reactive/boxed.ts:30

Returns

YMap<T>

Methods

bind()

bind(onChange): void

Defined in: packages/framework/store/src/reactive/boxed.ts:61

Parameters

onChange

OnBoxedChange

Returns

void

---

getValue()

getValue(): undefined | T

Defined in: packages/framework/store/src/reactive/boxed.ts:22

Returns

undefined | T

---

setValue()

setValue(value): T

Defined in: packages/framework/store/src/reactive/boxed.ts:26

Parameters

value

T

Returns

T

---

from()

static from<T>(map, onChange?): Boxed<T>

Defined in: packages/framework/store/src/reactive/boxed.ts:8

Type Parameters

T

T

Parameters

map

YMap<T>

onChange?

OnBoxedChange

Returns

Boxed<T>

---

is()

static is(value): value is Boxed<unknown>

Defined in: packages/framework/store/src/reactive/boxed.ts:12

Parameters

value

unknown

Returns

value is Boxed<unknown>