BlockSuite API Documentation / @blocksuite/store / Doc

Interface: Doc

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

Properties

id

readonly id: string

Defined in: packages/framework/store/src/model/doc.ts:18

---

slots

slots: object

Defined in: packages/framework/store/src/model/doc.ts:26

historyUpdated

historyUpdated: Subject<void>

yBlockUpdated

yBlockUpdated: Subject<{ id: string; isLocal: boolean; type: "add"; } | { id: string; isLocal: boolean; type: "delete"; }>

Accessors

awarenessStore

Get Signature

get awarenessStore(): AwarenessStore

Defined in: packages/framework/store/src/model/doc.ts:57

Returns

AwarenessStore

---

canRedo

Get Signature

get canRedo(): boolean

Defined in: packages/framework/store/src/model/doc.ts:43

Returns

boolean

---

canUndo

Get Signature

get canUndo(): boolean

Defined in: packages/framework/store/src/model/doc.ts:44

Returns

boolean

---

history

Get Signature

get history(): UndoManager

Defined in: packages/framework/store/src/model/doc.ts:42

Returns

UndoManager

---

loaded

Get Signature

get loaded(): boolean

Defined in: packages/framework/store/src/model/doc.ts:56

Returns

boolean

---

meta

Get Signature

get meta(): undefined | DocMeta

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

Returns

undefined | DocMeta

---

ready

Get Signature

get ready(): boolean

Defined in: packages/framework/store/src/model/doc.ts:23

Returns

boolean

---

rootDoc

Get Signature

get rootDoc(): Doc

Defined in: packages/framework/store/src/model/doc.ts:61

Returns

Doc

---

spaceDoc

Get Signature

get spaceDoc(): Doc

Defined in: packages/framework/store/src/model/doc.ts:62

Returns

Doc

---

workspace

Get Signature

get workspace(): Workspace

Defined in: packages/framework/store/src/model/doc.ts:59

Returns

Workspace

---

yBlocks

Get Signature

get yBlocks(): YMap<YBlock>

Defined in: packages/framework/store/src/model/doc.ts:63

Returns

YMap<YBlock>

Methods

captureSync()

captureSync(): void

Defined in: packages/framework/store/src/model/doc.ts:51

Returns

void

---

clear()

clear(): void

Defined in: packages/framework/store/src/model/doc.ts:52

Returns

void

---

clearQuery()

clearQuery(query, readonly?): void

Defined in: packages/framework/store/src/model/doc.ts:54

Parameters

query

Query

readonly?

boolean

Returns

void

---

dispose()

dispose(): void

Defined in: packages/framework/store/src/model/doc.ts:24

Returns

void

---

getStore()

getStore(options?): Store

Defined in: packages/framework/store/src/model/doc.ts:53

Parameters

options?

GetBlocksOptions

Returns

Store

---

load()

load(initFn?): void

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

Parameters

initFn?

() => void

Returns

void

---

redo()

redo(): void

Defined in: packages/framework/store/src/model/doc.ts:46

Returns

void

---

remove()

remove(): void

Defined in: packages/framework/store/src/model/doc.ts:21

Returns

void

---

resetHistory()

resetHistory(): void

Defined in: packages/framework/store/src/model/doc.ts:47

Returns

void

---

transact()

transact(fn, shouldTransact?): void

Defined in: packages/framework/store/src/model/doc.ts:48

Parameters

fn

() => void

shouldTransact?

boolean

Returns

void

---

undo()

undo(): void

Defined in: packages/framework/store/src/model/doc.ts:45

Returns

void

---

withoutTransact()

withoutTransact(fn): void

Defined in: packages/framework/store/src/model/doc.ts:49

Parameters

fn

() => void

Returns

void