BlockSuite API Documentation / @blocksuite/store / DocCollection

Class: DocCollection

Extends

• DocCollectionAddonType

Constructors

new DocCollection()

new DocCollection(__namedParameters): DocCollection

Parameters

• __namedParameters: DocCollectionOptions

Returns

DocCollection

Overrides

DocCollectionAddonType.constructor

Defined in

packages/framework/store/src/store/collection.ts:122

Properties

_schema

protected readonly _schema: Schema

Defined in

packages/framework/store/src/store/collection.ts:73

---

awarenessStore

readonly awarenessStore: AwarenessStore<BlockSuiteFlags>

Defined in

packages/framework/store/src/store/collection.ts:75

---

awarenessSync

readonly awarenessSync: AwarenessEngine

Defined in

packages/framework/store/src/store/collection.ts:77

---

blobSync

readonly blobSync: BlobEngine

Defined in

packages/framework/store/src/store/collection.ts:79

---

blockCollections

readonly blockCollections: Map<string, BlockCollection>

Defined in

packages/framework/store/src/store/collection.ts:81

---

doc

readonly doc: BlockSuiteDoc

Defined in

packages/framework/store/src/store/collection.ts:83

---

docSync

readonly docSync: DocEngine

Defined in

packages/framework/store/src/store/collection.ts:85

---

exportJSX()

exportJSX: (blockId?, docId?) => JSXElement

Parameters

• blockId?: string

• docId?: string

Returns

JSXElement

Inherited from

DocCollectionAddonType.exportJSX

Defined in

packages/framework/store/src/store/addon/type.ts:4

---

id

readonly id: string

Defined in

packages/framework/store/src/store/collection.ts:87

---

idGenerator

readonly idGenerator: IdGenerator

Defined in

packages/framework/store/src/store/collection.ts:89

---

importDocSnapshot()

importDocSnapshot: (json, docId) => Promise<void>

Parameters

• json: unknown

• docId: string

Returns

Promise<void>

Inherited from

DocCollectionAddonType.importDocSnapshot

Defined in

packages/framework/store/src/store/addon/type.ts:6

---

meta

meta: DocCollectionMeta

Defined in

packages/framework/store/src/store/collection.ts:91

---

slots

slots: object

docAdded

docAdded: Slot<string>

docCreated

docCreated: Slot<string>

docRemoved

docRemoved: Slot<string>

docUpdated

docUpdated: Slot<void>

Defined in

packages/framework/store/src/store/collection.ts:93

---

Y

static Y: __module

Defined in

packages/framework/store/src/store/collection.ts:71

Accessors

docs

get docs(): Map<string, BlockCollection>

Returns

Map<string, BlockCollection>

Defined in

packages/framework/store/src/store/collection.ts:100

---

isEmpty

get isEmpty(): boolean

Returns

boolean

Defined in

packages/framework/store/src/store/collection.ts:104

---

schema

get schema(): Schema

Returns

Schema

Defined in

packages/framework/store/src/store/collection.ts:118

Methods

canGracefulStop()

canGracefulStop(): void

Verify that all data has been successfully saved to the primary storage. Return true if the data transfer is complete and it is secure to terminate the synchronization operation.

Returns

void

Defined in

packages/framework/store/src/store/collection.ts:200

---

createDoc()

createDoc(options): Doc

By default, only an empty doc will be created. If the init parameter is passed, a surface, note, and paragraph block will be created in the doc simultaneously.

Parameters

• options = {}

• options.id?: string

• options.query?: Query

Returns

Doc

Defined in

packages/framework/store/src/store/collection.ts:209

---

forceStop()

forceStop(): void

Terminate the data sync process forcefully, which may cause data loss. It is advised to invoke canGracefulStop before calling this method.

Returns

void

Defined in

packages/framework/store/src/store/collection.ts:232

---

getBlockCollection()

getBlockCollection(docId): null | BlockCollection

Parameters

• docId: string

Returns

null | BlockCollection

Defined in

packages/framework/store/src/store/collection.ts:238

---

getDoc()

getDoc(docId, options?): null | Doc

Parameters

• docId: string

• options?: GetDocOptions

Returns

null | Doc

Defined in

packages/framework/store/src/store/collection.ts:243

---

removeDoc()

removeDoc(docId): void

Parameters

• docId: string

Returns

void

Defined in

packages/framework/store/src/store/collection.ts:248

---

setDocMeta()

setDocMeta(docId, props): void

Update doc meta state. Note that this intentionally does not mutate doc state.

Parameters

• docId: string

• props: Partial<DocMeta>

Returns

void

Defined in

packages/framework/store/src/store/collection.ts:266

---

start()

start(): void

Start the data sync process

Returns

void

Defined in

packages/framework/store/src/store/collection.ts:277

---

waitForGracefulStop()

waitForGracefulStop(abort?): Promise<void>

Wait for all data has been successfully saved to the primary storage.

Parameters

• abort?: AbortSignal

Returns

Promise<void>

Defined in

packages/framework/store/src/store/collection.ts:286

---

waitForSynced()

waitForSynced(): Promise<unknown>

Returns

Promise<unknown>

Defined in

packages/framework/store/src/store/collection.ts:290