Skip to content

BlockSuite API Documentation / @blocksuite/blocks / createEmbedBlockSchema

Function: createEmbedBlockSchema()

createEmbedBlockSchema<Props, Model, Transformer>(__namedParameters): object

Type parameters

Props extends object

Model extends EmbedBlockModel<Props>

Transformer extends BaseBlockTransformer<EmbedProps<Props>> = BaseBlockTransformer<EmbedProps<Props>>

Parameters

__namedParameters

__namedParameters.name: string

__namedParameters.props?

__namedParameters.toModel

__namedParameters.transformer?

__namedParameters.version: number

Returns

object

model

model: object & object

Type declaration

flavour

flavour: `affine:embed-${string}`

props

props: PropsGetter<EmbedProps<Props>>

Type declaration

role

role: "content" = 'content'

version

version: number

onUpgrade()?

optional onUpgrade: (data, previousVersion, latestVersion) => void

Parameters

data: EmbedProps<Props>

previousVersion: number

latestVersion: number

Returns

void

transformer()?

optional transformer: () => Transformer

Returns

Transformer

version

version: number

Source

packages/blocks/src/_common/embed-block-helper/helper.ts:16