Skip to content

API > @blocksuite/store > Store

Class: Store ​

Constructors ​

constructor ​

new Store(__namedParameters = ...): Store

Parameters ​

ParameterType
__namedParametersStoreOptions< BlockSuiteFlags >

Returns ​

Store

Defined In ​

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

Properties ​

awarenessStore ​

readonly awarenessStore: AwarenessStore< BlockSuiteFlags >

Defined In ​

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


doc ​

readonly doc: BlockSuiteDoc

Defined In ​

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


id ​

readonly id: string

Defined In ​

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


idGenerator ​

readonly idGenerator: IdGenerator

Defined In ​

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


providers ​

readonly providers: DocProvider[] = []

Defined In ​

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


spaces ​

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

Defined In ​

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

Methods ​

addSpace ​

addSpace(space): void

Parameters ​

ParameterType
spaceSpace< Record< string, any > >

Returns ​

void

Defined In ​

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


registerProvider ​

registerProvider(providerCreator, id?): DocProvider

Parameters ​

ParameterType
providerCreatorDocProviderCreator
id?string

Returns ​

DocProvider

Defined In ​

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


removeSpace ​

removeSpace(space): void

Parameters ​

ParameterType
spaceSpace< Record< string, any > >

Returns ​

void

Defined In ​

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