BlockSuite API Documentation / @blocksuite/blocks / SurfaceBlockTransformer

Class: SurfaceBlockTransformer

Extends

• BaseBlockTransformer<SurfaceBlockProps>

Constructors

new SurfaceBlockTransformer()

new SurfaceBlockTransformer(): SurfaceBlockTransformer

Returns

SurfaceBlockTransformer

Inherited from

BaseBlockTransformer.constructor

Properties

_internal

protected _internal: InternalPrimitives

Inherited from

BaseBlockTransformer._internal

Defined in

packages/framework/store/dist/transformer/base.d.ts:22

Methods

_propsFromSnapshot()

protected _propsFromSnapshot(propsJson): SurfaceBlockProps

Parameters

• propsJson: Record<string, unknown>

Returns

SurfaceBlockProps

Inherited from

BaseBlockTransformer._propsFromSnapshot

Defined in

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

---

_propsToSnapshot()

protected _propsToSnapshot(model): object

Parameters

• model: DraftModel

Returns

object

Inherited from

BaseBlockTransformer._propsToSnapshot

Defined in

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

---

elementFromJSON()

elementFromJSON(element): YMap<unknown>

Parameters

• element: Record<string, unknown>

Returns

YMap<unknown>

Defined in

packages/affine/block-surface/dist/surface-transformer.d.ts:8

---

fromSnapshot()

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

Parameters

• payload: FromSnapshotPayload

Returns

Promise<SnapshotReturn<SurfaceBlockProps>>

Overrides

BaseBlockTransformer.fromSnapshot

Defined in

packages/affine/block-surface/dist/surface-transformer.d.ts:9

---

toSnapshot()

toSnapshot(payload): Promise<object>

Parameters

• payload: ToSnapshotPayload<SurfaceBlockProps>

Returns

Promise<object>

flavour

flavour: string

id

id: string

props

props: Record<string, unknown>

version?

optional version: number

Overrides

BaseBlockTransformer.toSnapshot

Defined in

packages/affine/block-surface/dist/surface-transformer.d.ts:10