BlockSuite API Documentation / @blocksuite/store / Store

Class: Store

Contents

• Constructors
  • new Store(__namedParameters)
• Properties
  • awarenessStore
  • doc
  • id
  • idGenerator
  • providers
  • spaces
• Methods
  • addSpace()
  • registerProvider()
  • removeSpace()

Constructors

new Store(__namedParameters)

new Store(__namedParameters): Store

Parameters

• __namedParameters: StoreOptions<BlockSuiteFlags>= undefined

Returns

Store

Source

packages/store/src/workspace/store.ts:70

Properties

awarenessStore

readonly awarenessStore: AwarenessStore<BlockSuiteFlags>

Source

packages/store/src/workspace/store.ts:67

---

doc

readonly doc: BlockSuiteDoc

Source

packages/store/src/workspace/store.ts:64

---

id

readonly id: string

Source

packages/store/src/workspace/store.ts:63

---

idGenerator

readonly idGenerator: IdGenerator

Source

packages/store/src/workspace/store.ts:68

---

providers

readonly providers: DocProvider[] = []

Source

packages/store/src/workspace/store.ts:65

---

spaces

readonly spaces: Map<string, Space<Record<string, any>>>

Source

packages/store/src/workspace/store.ts:66

Methods

addSpace()

addSpace(space): void

Parameters

• space: Space<Record<string, any>>

Returns

void

Source

packages/store/src/workspace/store.ts:129

---

registerProvider()

registerProvider(providerCreator, id?): DocProvider

Parameters

• providerCreator: DocProviderCreator

• id?: string

Returns

DocProvider

Source

packages/store/src/workspace/store.ts:120

---

removeSpace()

removeSpace(space): void

Parameters

• space: Space<Record<string, any>>

Returns

void

Source

packages/store/src/workspace/store.ts:133

---

Generated using typedoc-plugin-markdown and TypeDoc