API > @blocksuite/store > Space

Class: Space<State> ​

Extended By ​

• Page

Constructors ​

constructor ​

new Space<State>( id, doc, awarenessStore): Space< State >

Type parameters ​

Parameters ​

Returns ​

Space< State >

Defined In ​

packages/store/src/workspace/space.ts:31

Properties ​

_loaded ​

private _loaded: boolean

Defined In ​

packages/store/src/workspace/space.ts:20

_onLoadSlot ​

private _onLoadSlot: Slot< void >

Defined In ​

packages/store/src/workspace/space.ts:22

_yBlocks ​

protected readonly _yBlocks: Map< State[keyof State] >

Defined In ​

packages/store/src/workspace/space.ts:29

_ySpaceDoc ​

protected readonly _ySpaceDoc: Doc

Used for convenient access to the underlying Yjs map, can be used interchangeably with ySpace

Defined In ​

packages/store/src/workspace/space.ts:28

awarenessStore ​

readonly awarenessStore: AwarenessStore< BlockSuiteFlags >

Defined In ​

packages/store/src/workspace/space.ts:18

doc ​

readonly doc: BlockSuiteDoc

Defined In ​

packages/store/src/workspace/space.ts:17

id ​

readonly id: string

Defined In ​

packages/store/src/workspace/space.ts:16

Accessors ​

loaded ​

get loaded(): boolean

Defined In ​

packages/store/src/workspace/space.ts:45

spaceDoc ​

get spaceDoc(): Doc

Defined In ​

packages/store/src/workspace/space.ts:49

yBlocks ​

get yBlocks(): Map< State[keyof State] >

Defined In ​

packages/store/src/workspace/space.ts:41

Methods ​

_initSubDoc ​

private _initSubDoc(): Doc

Returns ​

Doc

Defined In ​

packages/store/src/workspace/space.ts:86

_onSubdocEvent ​

private _onSubdocEvent(__namedParameters): void

Parameters ​

Returns ​

void

Defined In ​

packages/store/src/workspace/space.ts:103

clear ​

clear(): void

Returns ​

void

Defined In ​

packages/store/src/workspace/space.ts:82

destroy ​

destroy(): void

Returns ​

void

Defined In ​

packages/store/src/workspace/space.ts:76

load ​

load(): Promise< Space< State > >

Returns ​

Promise< Space< State > >

Defined In ​

packages/store/src/workspace/space.ts:53

remove ​

remove(): void

Returns ​

void

Defined In ​

packages/store/src/workspace/space.ts:71

transact ​

transact(fn, shouldTransact = true): void

If shouldTransact is false, the transaction will not be push to the history stack.

Parameters ​

Returns ​

void

Defined In ​

packages/store/src/workspace/space.ts:118