BlockSuite API Documentation / @blocksuite/blocks / PlainTextAdapter

Class: PlainTextAdapter

Extends

• BaseAdapter<PlainText>

Constructors

new PlainTextAdapter()

new PlainTextAdapter(job): PlainTextAdapter

Parameters

• job: Job

Returns

PlainTextAdapter

Inherited from

BaseAdapter.constructor

Source

packages/framework/store/dist/adapter/base.d.ts:46

Properties

configs

protected configs: Map<string, unknown>

Inherited from

BaseAdapter.configs

Source

packages/framework/store/dist/adapter/base.d.ts:44

---

job

job: Job

Inherited from

BaseAdapter.job

Source

packages/framework/store/dist/adapter/base.d.ts:45

Methods

_traverseSnapshot()

private _traverseSnapshot(snapshot): Promise<object>

Parameters

• snapshot: BlockSnapshot

Returns

Promise<object>

plaintext

plaintext: string

Source

packages/blocks/src/_common/adapters/plain-text.ts:36

---

applyConfigs()

applyConfigs(configs): void

Parameters

• configs: Map<string, unknown>

Returns

void

Inherited from

BaseAdapter.applyConfigs

Source

packages/framework/store/dist/adapter/base.d.ts:59

---

fromBlock()

fromBlock(mode): Promise<FromBlockSnapshotResult<string>>

Parameters

• mode: DraftModel

Returns

Promise<FromBlockSnapshotResult<string>>

Inherited from

BaseAdapter.fromBlock

Source

packages/framework/store/dist/adapter/base.d.ts:55

---

fromBlockSnapshot()

fromBlockSnapshot(__namedParameters): Promise<FromBlockSnapshotResult<string>>

Parameters

• __namedParameters: FromBlockSnapshotPayload

Returns

Promise<FromBlockSnapshotResult<string>>

Overrides

BaseAdapter.fromBlockSnapshot

Source

packages/blocks/src/_common/adapters/plain-text.ts:96

---

fromDoc()

fromDoc(doc): Promise<FromDocSnapshotResult<string>>

Parameters

• doc: Doc

Returns

Promise<FromDocSnapshotResult<string>>

Inherited from

BaseAdapter.fromDoc

Source

packages/framework/store/dist/adapter/base.d.ts:53

---

fromDocSnapshot()

fromDocSnapshot(__namedParameters): Promise<FromDocSnapshotResult<string>>

Parameters

• __namedParameters: FromDocSnapshotPayload

Returns

Promise<FromDocSnapshotResult<string>>

Overrides

BaseAdapter.fromDocSnapshot

Source

packages/blocks/src/_common/adapters/plain-text.ts:77

---

fromSlice()

fromSlice(slice): Promise<FromSliceSnapshotResult<string>>

Parameters

• slice: Slice

Returns

Promise<FromSliceSnapshotResult<string>>

Inherited from

BaseAdapter.fromSlice

Source

packages/framework/store/dist/adapter/base.d.ts:57

---

fromSliceSnapshot()

fromSliceSnapshot(__namedParameters): Promise<FromSliceSnapshotResult<string>>

Parameters

• __namedParameters: FromSliceSnapshotPayload

Returns

Promise<FromSliceSnapshotResult<string>>

Overrides

BaseAdapter.fromSliceSnapshot

Source

packages/blocks/src/_common/adapters/plain-text.ts:106

---

toBlock()

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

Parameters

• payload: ToBlockSnapshotPayload<string>

• doc: Doc

• parent?: string

• index?: number

Returns

Promise<BlockModel<object>>

Inherited from

BaseAdapter.toBlock

Source

packages/framework/store/dist/adapter/base.d.ts:56

---

toBlockSnapshot()

toBlockSnapshot(payload): BlockSnapshot

Parameters

• payload: ToBlockSnapshotPayload<string>

Returns

BlockSnapshot

Overrides

BaseAdapter.toBlockSnapshot

Source

packages/blocks/src/_common/adapters/plain-text.ts:193

---

toDoc()

toDoc(payload): Promise<Doc>

Parameters

• payload: ToDocSnapshotPayload<string>

Returns

Promise<Doc>

Inherited from

BaseAdapter.toDoc

Source

packages/framework/store/dist/adapter/base.d.ts:54

---

toDocSnapshot()

toDocSnapshot(payload): DocSnapshot

Parameters

• payload: ToDocSnapshotPayload<string>

Returns

DocSnapshot

Overrides

BaseAdapter.toDocSnapshot

Source

packages/blocks/src/_common/adapters/plain-text.ts:123

---

toSlice()

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

Parameters

• payload: ToSliceSnapshotPayload<string>

• doc: Doc

• parent?: string

• index?: number

Returns

Promise<undefined | Slice>

Inherited from

BaseAdapter.toSlice

Source

packages/framework/store/dist/adapter/base.d.ts:58

---

toSliceSnapshot()

toSliceSnapshot(payload): null | SliceSnapshot

Parameters

• payload: PlainTextToSliceSnapshotPayload

Returns

null | SliceSnapshot

Overrides

BaseAdapter.toSliceSnapshot

Source

packages/blocks/src/_common/adapters/plain-text.ts:228