API > @blocksuite/store > PassiveDocProvider

Interface: PassiveDocProvider ​

Description ​

If a provider is marked as passive, it's supposed to be connected in the background. This means that the data might be stale when you use it.

Extends ​

• BaseDocProvider

Properties ​

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

passive ​

passive: true

Defined In ​

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

Accessors ​

connected ​

get connected(): boolean

Defined In ​

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

Methods ​

connect ​

connect(): void

Returns ​

void

Defined In ​

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

disconnect ​

disconnect(): void

Returns ​

void

Defined In ​

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