BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/blocks / HtmlAdapter

Class: HtmlAdapter ​

Extends ​

Constructors ​

new HtmlAdapter() ​

new HtmlAdapter(job, blockMatchers): HtmlAdapter

Parameters ​

job ​

Job

blockMatchers ​

BlockHtmlAdapterMatcher[] = defaultBlockHtmlAdapterMatchers

Returns ​

HtmlAdapter

Overrides ​

BaseAdapter.constructor

Defined in ​

packages/blocks/src/_common/adapters/html-adapter/html.ts:174

Properties ​

blockMatchers ​

readonly blockMatchers: BlockHtmlAdapterMatcher[] = defaultBlockHtmlAdapterMatchers

Defined in ​

packages/blocks/src/_common/adapters/html-adapter/html.ts:176

deltaConverter ​

deltaConverter: HtmlDeltaConverter

Defined in ​

packages/blocks/src/_common/adapters/html-adapter/html.ts:172

job ​

job: Job

Inherited from ​

BaseAdapter.job

Defined in ​

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

Accessors ​

configs ​

Get Signature ​

get configs(): Map<string, string>

Returns ​

Map<string, string>

Inherited from ​

BaseAdapter.configs

Defined in ​

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

Methods ​

fromBlock() ​

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

Parameters ​

model ​

DraftModel

Returns ​

Promise<undefined | FromBlockSnapshotResult<string>>

Inherited from ​

BaseAdapter.fromBlock

Defined in ​

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

fromBlockSnapshot() ​

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

Parameters ​

payload ​

FromBlockSnapshotPayload

Returns ​

Promise<FromBlockSnapshotResult<string>>

Overrides ​

BaseAdapter.fromBlockSnapshot

Defined in ​

packages/blocks/src/_common/adapters/html-adapter/html.ts:190

fromDoc() ​

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

Parameters ​

doc ​

Doc

Returns ​

Promise<undefined | FromDocSnapshotResult<string>>

Inherited from ​

BaseAdapter.fromDoc

Defined in ​

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

fromDocSnapshot() ​

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

Parameters ​

payload ​

FromDocSnapshotPayload

Returns ​

Promise<FromDocSnapshotResult<string>>

Overrides ​

BaseAdapter.fromDocSnapshot

Defined in ​

packages/blocks/src/_common/adapters/html-adapter/html.ts:212

fromSlice() ​

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

Parameters ​

slice ​

Slice

Returns ​

Promise<undefined | FromSliceSnapshotResult<string>>

Inherited from ​

BaseAdapter.fromSlice

Defined in ​

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

fromSliceSnapshot() ​

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

Parameters ​

payload ​

FromSliceSnapshotPayload

Returns ​

Promise<FromSliceSnapshotResult<string>>

Overrides ​

BaseAdapter.fromSliceSnapshot

Defined in ​

packages/blocks/src/_common/adapters/html-adapter/html.ts:228

toBlock() ​

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

Parameters ​

payload ​

ToBlockSnapshotPayload<string>

doc ​

Doc

parent? ​

string

index? ​

number

Returns ​

Promise<undefined | BlockModel<object, object>>

Inherited from ​

BaseAdapter.toBlock

Defined in ​

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

toBlockSnapshot() ​

toBlockSnapshot(payload): Promise<BlockSnapshot>

Parameters ​

payload ​

ToBlockSnapshotPayload<string>

Returns ​

Promise<BlockSnapshot>

Overrides ​

BaseAdapter.toBlockSnapshot

Defined in ​

packages/blocks/src/_common/adapters/html-adapter/html.ts:253

toDoc() ​

toDoc(payload): Promise<undefined | Doc>

Parameters ​

payload ​

ToDocSnapshotPayload<string>

Returns ​

Promise<undefined | Doc>

Inherited from ​

BaseAdapter.toDoc

Defined in ​

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

toDocSnapshot() ​

toDocSnapshot(payload): Promise<DocSnapshot>

Parameters ​

payload ​

ToDocSnapshotPayload<string>

Returns ​

Promise<DocSnapshot>

Overrides ​

BaseAdapter.toDocSnapshot

Defined in ​

packages/blocks/src/_common/adapters/html-adapter/html.ts:277

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

Defined in ​

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

toSliceSnapshot() ​

toSliceSnapshot(payload): Promise<null | SliceSnapshot>

Parameters ​

payload ​

HtmlToSliceSnapshotPayload

Returns ​

Promise<null | SliceSnapshot>

Overrides ​

BaseAdapter.toSliceSnapshot

Defined in ​

packages/blocks/src/_common/adapters/html-adapter/html.ts:338

Copyright © 2022-present Toeverything