API > @blocksuite/store > Schema

Class: Schema ​

Constructors ​

constructor ​

new Schema(): Schema

Returns ​

Schema

Properties ​

flavourSchemaMap ​

readonly flavourSchemaMap: Map< string, {model: { flavour: string; role: "root" | "hub" | "content"; parent?: string[] | undefined; children?: string[] | undefined; props?: ((args_0: InternalPrimitives, ...args_1: unknown[]) => Record<...>) | undefined; toModel?: ((...args: unknown[]) => BaseBlockModel<...>) | undefined; }; onUpgrade: (...args) => void; transformer: (...args) => BaseBlockTransformer< object >; version: number;} >

Defined In ​

packages/store/src/schema/schema.ts:13

Accessors ​

versions ​

get versions(): object

Defined In ​

packages/store/src/schema/schema.ts:15

Methods ​

_matchFlavour ​

private _matchFlavour(childFlavour, parentFlavour): boolean

Parameters ​

Returns ​

boolean

Defined In ​

packages/store/src/schema/schema.ts:218

_upgradeBlockVersions ​

private _upgradeBlockVersions(rootData): void

Parameters ​

Returns ​

void

Defined In ​

packages/store/src/schema/schema.ts:176

_validateParent ​

private _validateParent(child, parent): boolean

Parameters ​

Returns ​

boolean

Defined In ​

packages/store/src/schema/schema.ts:225

_validateRole ​

private _validateRole(child, parent): void

Parameters ​

Returns ​

void

Defined In ​

packages/store/src/schema/schema.ts:190

register ​

register(blockSchema): Schema

Parameters ​

Returns ​

Schema

Defined In ​

packages/store/src/schema/schema.ts:38

toJSON ​

toJSON(): object

Returns ​

object

Defined In ​

packages/store/src/schema/schema.ts:23

upgradeBlock ​

upgradeBlock( flavour, oldVersion, blockData): void

Parameters ​

Returns ​

void

Defined In ​

packages/store/src/schema/schema.ts:154

upgradePage ​

upgradePage( oldPageVersion, oldBlockVersions, pageData): void

Parameters ​

Returns ​

void

Defined In ​

packages/store/src/schema/schema.ts:124

upgradeWorkspace ​

upgradeWorkspace(rootData): void

Parameters ​

Returns ​

void

Defined In ​

packages/store/src/schema/schema.ts:110

validate ​

validate( flavour, parentFlavour?, childFlavours?): void

Parameters ​

Returns ​

void

Defined In ​

packages/store/src/schema/schema.ts:46

validateSchema ​

validateSchema(child, parent): void

Parameters ​

Returns ​

void

Defined In ​

packages/store/src/schema/schema.ts:97