Skip to content

BlockSuite API Documentation / @blocksuite/store / WorkspaceMeta

Interface: WorkspaceMeta

Defined in: packages/framework/store/src/model/workspace-meta.ts:22

Properties

commonFieldsUpdated

commonFieldsUpdated: Subject<void>

Defined in: packages/framework/store/src/model/workspace-meta.ts:42


docMetaAdded

docMetaAdded: Subject<string>

Defined in: packages/framework/store/src/model/workspace-meta.ts:43


docMetaRemoved

docMetaRemoved: Subject<string>

Defined in: packages/framework/store/src/model/workspace-meta.ts:44


docMetaUpdated

docMetaUpdated: Subject<void>

Defined in: packages/framework/store/src/model/workspace-meta.ts:45

Accessors

avatar

Get Signature

get avatar(): undefined | string

Defined in: packages/framework/store/src/model/workspace-meta.ts:33

Returns

undefined | string


docMetas

Get Signature

get docMetas(): DocMeta[]

Defined in: packages/framework/store/src/model/workspace-meta.ts:23

Returns

DocMeta[]


docs

Get Signature

get docs(): undefined | unknown[]

Defined in: packages/framework/store/src/model/workspace-meta.ts:39

Returns

undefined | unknown[]


name

Get Signature

get name(): undefined | string

Defined in: packages/framework/store/src/model/workspace-meta.ts:36

Returns

undefined | string


properties

Get Signature

get properties(): DocsPropertiesMeta

Defined in: packages/framework/store/src/model/workspace-meta.ts:30

Returns

DocsPropertiesMeta

Methods

addDocMeta()

addDocMeta(props, index?): void

Defined in: packages/framework/store/src/model/workspace-meta.ts:25

Parameters

props

DocMeta

index?

number

Returns

void


getDocMeta()

getDocMeta(id): undefined | DocMeta

Defined in: packages/framework/store/src/model/workspace-meta.ts:26

Parameters

id

string

Returns

undefined | DocMeta


initialize()

initialize(): void

Defined in: packages/framework/store/src/model/workspace-meta.ts:40

Returns

void


removeDocMeta()

removeDocMeta(id): void

Defined in: packages/framework/store/src/model/workspace-meta.ts:28

Parameters

id

string

Returns

void


setAvatar()

setAvatar(avatar): void

Defined in: packages/framework/store/src/model/workspace-meta.ts:34

Parameters

avatar

string

Returns

void


setDocMeta()

setDocMeta(id, props): void

Defined in: packages/framework/store/src/model/workspace-meta.ts:27

Parameters

id

string

props

Partial<DocMeta>

Returns

void


setName()

setName(name): void

Defined in: packages/framework/store/src/model/workspace-meta.ts:37

Parameters

name

string

Returns

void


setProperties()

setProperties(meta): void

Defined in: packages/framework/store/src/model/workspace-meta.ts:31

Parameters

meta

DocsPropertiesMeta

Returns

void