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

Contents

• Properties
  • cleanup
  • flavour
  • passive
• Accessors
  • connected
• Methods
  • connect
  • disconnect

Properties

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

---

passive

passive: true

Source

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

Accessors

connected

get connected(): boolean

Returns

boolean

Source

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

Methods

connect()

connect(): void

Returns

void

Source

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

---

disconnect()

disconnect(): void

Returns

void

Source

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

---

Generated using typedoc-plugin-markdown and TypeDoc