API > @blocksuite/store > ActiveDocProvider

Interface: ActiveDocProvider ​

Description ​

If a provider is marked as active, it's supposed to be connected before you can use it. This means that the data will be fresh before you use it.

Extends ​

• BaseDocProvider

Properties ​

active ​

active: true

Defined In ​

packages/store/src/providers/type.ts:37

cleanup ​

optional cleanup: function

Returns ​

void

Description ​

Cleanup data when doc is removed.

Defined In ​

packages/store/src/providers/type.ts:16

Inherited from ​

BaseDocProvider.cleanup

flavour ​

flavour: string

Defined In ​

packages/store/src/providers/type.ts:10

Inherited from ​

BaseDocProvider.flavour

Accessors ​

whenReady ​

get whenReady(): Promise< void >

Defined In ​

packages/store/src/providers/type.ts:44

Methods ​

sync ​

sync(): void

Returns ​

void

Defined In ​

packages/store/src/providers/type.ts:38