BlockSuite API Documentation / @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

Contents

• Properties
  • active
  • cleanup
  • flavour
• Accessors
  • whenReady
• Methods
  • sync

Properties

active

active: true

Source

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

---

cleanup?

cleanup?: () => void

Returns

void

Description

Cleanup data when doc is removed.

Inherited from

@blocksuite/store.BaseDocProvider.cleanup

Source

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

---

flavour

flavour: string

Inherited from

@blocksuite/store.BaseDocProvider.flavour

Source

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

Accessors

whenReady

get whenReady(): Promise<void>

Description

Each time you call sync, it will return a new promise instance.

Returns

Promise<void>

Source

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

Methods

sync()

sync(): void

Returns

void

Source

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

---

Generated using typedoc-plugin-markdown and TypeDoc