BlockSuite API Documentation / @blocksuite/store / BaseAdapter

Class: abstract BaseAdapter<AdapterTarget>

Extended By

Type parameters

• AdapterTarget = unknown

Contents

• Constructors
  • new BaseAdapter
• Properties
  • configs
• Methods
  • applyConfigs
  • fromBlockSnapshot
  • fromPageSnapshot
  • fromSliceSnapshot
  • toBlockSnapshot
  • toPageSnapshot
  • toSliceSnapshot

Constructors

new BaseAdapter(undefined)

new BaseAdapter<AdapterTarget>(): BaseAdapter<AdapterTarget>

Returns

BaseAdapter<AdapterTarget>

Properties

configs

protected configs: Map<string, unknown>

Source

packages/store/src/adapter/base.ts:49

Methods

applyConfigs()

applyConfigs(configs): void

Parameters

• configs: Map<string, unknown>

Returns

void

Source

packages/store/src/adapter/base.ts:70

---

abstract fromBlockSnapshot()

abstract fromBlockSnapshot(payload): Promise<FromBlockSnapshotResult<AdapterTarget>>

Parameters

• payload: FromBlockSnapshotPayload

Returns

Promise<FromBlockSnapshotResult<AdapterTarget>>

Source

packages/store/src/adapter/base.ts:54

---

abstract fromPageSnapshot()

abstract fromPageSnapshot(payload): Promise<FromPageSnapshotResult<AdapterTarget>>

Parameters

• payload: FromPageSnapshotPayload

Returns

Promise<FromPageSnapshotResult<AdapterTarget>>

Source

packages/store/src/adapter/base.ts:51

---

abstract fromSliceSnapshot()

abstract fromSliceSnapshot(payload): Promise<FromSliceSnapshotResult<AdapterTarget>>

Parameters

• payload: FromSliceSnapshotPayload

Returns

Promise<FromSliceSnapshotResult<AdapterTarget>>

Source

packages/store/src/adapter/base.ts:57

---

abstract toBlockSnapshot()

abstract toBlockSnapshot(payload): Promise<BlockSnapshot>

Parameters

• payload: ToBlockSnapshotPayload<AdapterTarget>

Returns

Promise<BlockSnapshot>

Source

packages/store/src/adapter/base.ts:63

---

abstract toPageSnapshot()

abstract toPageSnapshot(payload): Promise<PageSnapshot>

Parameters

• payload: ToPageSnapshotPayload<AdapterTarget>

Returns

Promise<PageSnapshot>

Source

packages/store/src/adapter/base.ts:60

---

abstract toSliceSnapshot()

abstract toSliceSnapshot(payload): Promise<null | SliceSnapshot>

Parameters

• payload: ToSliceSnapshotPayload<AdapterTarget>

Returns

Promise<null | SliceSnapshot>

Source

packages/store/src/adapter/base.ts:66

---

Generated using typedoc-plugin-markdown and TypeDoc