BlockSuite API Documentation / @blocksuite/store / BaseAdapter

Class: abstract BaseAdapter<AdapterTarget>

Defined in: packages/framework/store/src/adapter/base.ts:69

Type Parameters

AdapterTarget

AdapterTarget = unknown

Constructors

new BaseAdapter()

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

Defined in: packages/framework/store/src/adapter/base.ts:76

Parameters

job

Transformer

Returns

BaseAdapter<AdapterTarget>

Properties

job

job: Transformer

Defined in: packages/framework/store/src/adapter/base.ts:70

Accessors

configs

Get Signature

get configs(): Map<string, string>

Defined in: packages/framework/store/src/adapter/base.ts:72

Returns

Map<string, string>

Methods

fromBlock()

fromBlock(model): Promise<undefined | FromBlockSnapshotResult<AdapterTarget>>

Defined in: packages/framework/store/src/adapter/base.ts:80

Parameters

model

BlockModel<object> | DraftModel

Returns

Promise<undefined | FromBlockSnapshotResult<AdapterTarget>>

---

fromBlockSnapshot()

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

Defined in: packages/framework/store/src/adapter/base.ts:97

Parameters

payload

FromBlockSnapshotPayload

Returns

FromBlockSnapshotResult<AdapterTarget> | Promise<FromBlockSnapshotResult<AdapterTarget>>

---

fromDoc()

fromDoc(doc): Promise<undefined | FromDocSnapshotResult<AdapterTarget>>

Defined in: packages/framework/store/src/adapter/base.ts:103

Parameters

doc

Store

Returns

Promise<undefined | FromDocSnapshotResult<AdapterTarget>>

---

fromDocSnapshot()

abstract fromDocSnapshot(payload): FromDocSnapshotResult<AdapterTarget> | Promise<FromDocSnapshotResult<AdapterTarget>>

Defined in: packages/framework/store/src/adapter/base.ts:118

Parameters

payload

FromDocSnapshotPayload

Returns

FromDocSnapshotResult<AdapterTarget> | Promise<FromDocSnapshotResult<AdapterTarget>>

---

fromSlice()

fromSlice(slice): Promise<undefined | FromSliceSnapshotResult<AdapterTarget>>

Defined in: packages/framework/store/src/adapter/base.ts:124

Parameters

slice

Slice

Returns

Promise<undefined | FromSliceSnapshotResult<AdapterTarget>>

---

fromSliceSnapshot()

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

Defined in: packages/framework/store/src/adapter/base.ts:140

Parameters

payload

FromSliceSnapshotPayload

Returns

FromSliceSnapshotResult<AdapterTarget> | Promise<FromSliceSnapshotResult<AdapterTarget>>

---

toBlock()

toBlock(payload, doc, parent?, index?): Promise<undefined | BlockModel<object>>

Defined in: packages/framework/store/src/adapter/base.ts:146

Parameters

payload

ToBlockSnapshotPayload<AdapterTarget>

doc

Store

parent?

string

index?

number

Returns

Promise<undefined | BlockModel<object>>

---

toBlockSnapshot()

abstract toBlockSnapshot(payload): BlockSnapshot | Promise<BlockSnapshot>

Defined in: packages/framework/store/src/adapter/base.ts:163

Parameters

payload

ToBlockSnapshotPayload<AdapterTarget>

Returns

BlockSnapshot | Promise<BlockSnapshot>

---

toDoc()

toDoc(payload): Promise<undefined | Store>

Defined in: packages/framework/store/src/adapter/base.ts:167

Parameters

payload

ToDocSnapshotPayload<AdapterTarget>

Returns

Promise<undefined | Store>

---

toDocSnapshot()

abstract toDocSnapshot(payload): DocSnapshot | Promise<DocSnapshot>

Defined in: packages/framework/store/src/adapter/base.ts:179

Parameters

payload

ToDocSnapshotPayload<AdapterTarget>

Returns

DocSnapshot | Promise<DocSnapshot>

---

toSlice()

toSlice(payload, doc, parent?, index?): Promise<undefined | Slice>

Defined in: packages/framework/store/src/adapter/base.ts:183

Parameters

payload

ToSliceSnapshotPayload<AdapterTarget>

doc

Store

parent?

string

index?

number

Returns

Promise<undefined | Slice>

---

toSliceSnapshot()

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

Defined in: packages/framework/store/src/adapter/base.ts:200

Parameters

payload

ToSliceSnapshotPayload<AdapterTarget>

Returns

null | SliceSnapshot | Promise<null | SliceSnapshot>