BlockSuite API Documentation / @blocksuite/store / Boxed

Class: Boxed<T>

Contents

• Type parameters
• Constructors
  • new Boxed(value)
• Properties
  • _map
• Accessors
  • yMap
• Methods
  • getValue()
  • setValue()
  • from()
  • is()

Type parameters

• T = unknown

Constructors

new Boxed(value)

new Boxed<T>(value): Boxed<T>

Parameters

• value: T

Returns

Boxed<T>

Source

packages/store/src/reactive/boxed.ts:17

Properties

_map

private readonly _map: Map<T>

Source

packages/store/src/reactive/boxed.ts:6

Accessors

yMap

get yMap(): Map<T>

Returns

Map<T>

Source

packages/store/src/reactive/boxed.ts:30

Methods

getValue()

getValue(): undefined | T

Returns

undefined | T

Source

packages/store/src/reactive/boxed.ts:38

---

setValue()

setValue(value): T

Parameters

• value: T

Returns

T

Source

packages/store/src/reactive/boxed.ts:34

---

from()

static from<T>(map): Boxed<T>

Type parameters

• T

Parameters

• map: Map<T>

Returns

Boxed<T>

Source

packages/store/src/reactive/boxed.ts:13

---

is()

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

Parameters

• value: unknown

Returns

value is Boxed<unknown>

Source

packages/store/src/reactive/boxed.ts:7

---

Generated using typedoc-plugin-markdown and TypeDoc