BlockSuite API Documentation / @blocksuite/affine-block-surface / SurfaceBlockTransformer

Class: SurfaceBlockTransformer

Defined in: packages/affine/blocks/block-surface/src/surface-transformer.ts:14

Extends

• BaseBlockTransformer<SurfaceBlockProps>

Constructors

new SurfaceBlockTransformer()

new SurfaceBlockTransformer(transformerConfigs): SurfaceBlockTransformer

Defined in: packages/framework/store/dist/transformer/base.d.ts:29

Parameters

transformerConfigs

Map<string, unknown>

Returns

SurfaceBlockTransformer

Inherited from

BaseBlockTransformer.constructor

Properties

_internal

protected _internal: InternalPrimitives

Defined in: packages/framework/store/dist/transformer/base.d.ts:24

Inherited from

BaseBlockTransformer._internal

---

transformerConfigs

readonly transformerConfigs: Map<string, unknown>

Defined in: packages/framework/store/dist/transformer/base.d.ts:23

Inherited from

BaseBlockTransformer.transformerConfigs

Methods

_propsFromSnapshot()

protected _propsFromSnapshot(propsJson): SurfaceBlockProps

Defined in: packages/framework/store/dist/transformer/base.d.ts:25

Parameters

propsJson

Record<string, unknown>

Returns

SurfaceBlockProps

Inherited from

BaseBlockTransformer._propsFromSnapshot

---

_propsToSnapshot()

protected _propsToSnapshot(model): object

Defined in: packages/framework/store/dist/transformer/base.d.ts:26

Parameters

model

BlockModel<object> | DraftModel

Returns

object

Inherited from

BaseBlockTransformer._propsToSnapshot

---

elementFromJSON()

elementFromJSON(element): YMap<unknown>

Defined in: packages/affine/blocks/block-surface/src/surface-transformer.ts:57

Parameters

element

Record<string, unknown>

Returns

YMap<unknown>

---

fromSnapshot()

fromSnapshot(payload): Promise<SnapshotNode<SurfaceBlockProps>>

Defined in: packages/affine/blocks/block-surface/src/surface-transformer.ts:66

Parameters

payload

FromSnapshotPayload

Returns

Promise<SnapshotNode<SurfaceBlockProps>>

Overrides

BaseBlockTransformer.fromSnapshot

---

toSnapshot()

toSnapshot(payload): BlockSnapshotLeaf

Defined in: packages/affine/blocks/block-surface/src/surface-transformer.ts:91

Parameters

payload

ToSnapshotPayload<SurfaceBlockProps>

Returns

BlockSnapshotLeaf

Overrides

BaseBlockTransformer.toSnapshot