BlockSuite API Documentation / @blocksuite/store / Transformer

Class: Transformer

Defined in: packages/framework/store/src/transformer/transformer.ts:59

Constructors

new Transformer()

new Transformer(__namedParameters): Transformer

Defined in: packages/framework/store/src/transformer/transformer.ts:357

Parameters

__namedParameters

TransformerOptions

Returns

Transformer

Accessors

adapterConfigs

Get Signature

get adapterConfigs(): Map<string, string>

Defined in: packages/framework/store/src/transformer/transformer.ts:337

Returns

Map<string, string>

---

assets

Get Signature

get assets(): Map<string, Blob>

Defined in: packages/framework/store/src/transformer/transformer.ts:341

Returns

Map<string, Blob>

---

assetsManager

Get Signature

get assetsManager(): AssetsManager

Defined in: packages/framework/store/src/transformer/transformer.ts:345

Returns

AssetsManager

---

docCRUD

Get Signature

get docCRUD(): DocCRUD

Defined in: packages/framework/store/src/transformer/transformer.ts:353

Returns

DocCRUD

---

schema

Get Signature

get schema(): Schema

Defined in: packages/framework/store/src/transformer/transformer.ts:349

Returns

Schema

Methods

blockToSnapshot()

blockToSnapshot(model): undefined | BlockSnapshot

Defined in: packages/framework/store/src/transformer/transformer.ts:77

Parameters

model

BlockModel<object> | DraftModel

Returns

undefined | BlockSnapshot

---

docToSnapshot()

docToSnapshot(doc): undefined | DocSnapshot

Defined in: packages/framework/store/src/transformer/transformer.ts:100

Parameters

doc

Store

Returns

undefined | DocSnapshot

---

reset()

reset(): void

Defined in: packages/framework/store/src/transformer/transformer.ts:645

Returns

void

---

sliceToSnapshot()

sliceToSnapshot(slice): undefined | SliceSnapshot

Defined in: packages/framework/store/src/transformer/transformer.ts:138

Parameters

slice

Slice

Returns

undefined | SliceSnapshot

---

snapshotToBlock()

snapshotToBlock(snapshot, doc, parent?, index?): Promise<undefined | BlockModel<object>>

Defined in: packages/framework/store/src/transformer/transformer.ts:174

Parameters

snapshot

BlockSnapshot

doc

Store

parent?

string

index?

number

Returns

Promise<undefined | BlockModel<object>>

---

snapshotToDoc()

snapshotToDoc(snapshot): Promise<undefined | Store>

Defined in: packages/framework/store/src/transformer/transformer.ts:192

Parameters

snapshot

DocSnapshot

Returns

Promise<undefined | Store>

---

snapshotToModelData()

snapshotToModelData(snapshot): Promise<undefined | SnapshotNode<object>>

Defined in: packages/framework/store/src/transformer/transformer.ts:217

Parameters

snapshot

BlockSnapshot

Returns

Promise<undefined | SnapshotNode<object>>

---

snapshotToSlice()

snapshotToSlice(snapshot, doc, parent?, index?): Promise<undefined | Slice>

Defined in: packages/framework/store/src/transformer/transformer.ts:242

Parameters

snapshot

SliceSnapshot

doc

Store

parent?

string

index?

number

Returns

Promise<undefined | Slice>

---

walk()

walk(snapshot, callback): void

Defined in: packages/framework/store/src/transformer/transformer.ts:320

Parameters

snapshot

DocSnapshot

callback

(block) => void

Returns

void