Skip to content

BlockSuite API Documentation / @blocksuite/store / BaseBlockTransformer

Class: BaseBlockTransformer<Props>

Defined in: packages/framework/store/src/transformer/base.ts:34

Extended by

Type Parameters

Props

Props extends object = object

Constructors

new BaseBlockTransformer()

new BaseBlockTransformer<Props>(transformerConfigs): BaseBlockTransformer<Props>

Defined in: packages/framework/store/src/transformer/base.ts:60

Parameters

transformerConfigs

Map<string, unknown>

Returns

BaseBlockTransformer<Props>

Properties

_internal

protected _internal: InternalPrimitives = internalPrimitives

Defined in: packages/framework/store/src/transformer/base.ts:35


transformerConfigs

readonly transformerConfigs: Map<string, unknown>

Defined in: packages/framework/store/src/transformer/base.ts:60

Methods

_propsFromSnapshot()

protected _propsFromSnapshot(propsJson): Props

Defined in: packages/framework/store/src/transformer/base.ts:37

Parameters

propsJson

Record<string, unknown>

Returns

Props


_propsToSnapshot()

protected _propsToSnapshot(model): object

Defined in: packages/framework/store/src/transformer/base.ts:45

Parameters

model

BlockModel<object> | DraftModel

Returns

object


fromSnapshot()

fromSnapshot(__namedParameters): SnapshotNode<Props> | Promise<SnapshotNode<Props>>

Defined in: packages/framework/store/src/transformer/base.ts:62

Parameters

__namedParameters

FromSnapshotPayload

Returns

SnapshotNode<Props> | Promise<SnapshotNode<Props>>


toSnapshot()

toSnapshot(__namedParameters): BlockSnapshotLeaf

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

Parameters

__namedParameters

ToSnapshotPayload<Props>

Returns

BlockSnapshotLeaf