BlockSuite API Documentation / @blocksuite/store / Workspace

Interface: Workspace

Defined in: packages/framework/store/src/model/workspace.ts:11

Properties

blobSync

readonly blobSync: BlobEngine

Defined in: packages/framework/store/src/model/workspace.ts:15

---

id

readonly id: string

Defined in: packages/framework/store/src/model/workspace.ts:12

---

idGenerator

readonly idGenerator: IdGenerator

Defined in: packages/framework/store/src/model/workspace.ts:14

---

meta

readonly meta: WorkspaceMeta

Defined in: packages/framework/store/src/model/workspace.ts:13

---

onLoadAwareness()?

readonly optional onLoadAwareness: (awareness) => void

Defined in: packages/framework/store/src/model/workspace.ts:17

Parameters

awareness

Awareness

Returns

void

---

onLoadDoc()?

readonly optional onLoadDoc: (doc) => void

Defined in: packages/framework/store/src/model/workspace.ts:16

Parameters

doc

Doc

Returns

void

---

slots

slots: object

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

docCreated

docCreated: Subject<string>

docListUpdated

docListUpdated: Subject<void>

docRemoved

docRemoved: Subject<string>

Accessors

doc

Get Signature

get doc(): Doc

Defined in: packages/framework/store/src/model/workspace.ts:19

Returns

Doc

---

docs

Get Signature

get docs(): Map<string, Doc>

Defined in: packages/framework/store/src/model/workspace.ts:20

Returns

Map<string, Doc>

Methods

createDoc()

createDoc(options?): Store

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

Parameters

options?

CreateBlocksOptions

Returns

Store

---

dispose()

dispose(): void

Defined in: packages/framework/store/src/model/workspace.ts:32

Returns

void

---

getDoc()

getDoc(docId, options?): null | Store

Defined in: packages/framework/store/src/model/workspace.ts:29

Parameters

docId

string

options?

GetBlocksOptions

Returns

null | Store

---

removeDoc()

removeDoc(docId): void

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

Parameters

docId

string

Returns

void