Skip to content

BlockSuite API Documentation / @blocksuite/store / Job

Class: Job

Constructors

new Job()

new Job(__namedParameters): Job

Parameters

__namedParameters: JobConfig

Returns

Job

Defined in

packages/framework/store/src/transformer/job.ts:322

Accessors

adapterConfigs

get adapterConfigs(): Map<string, string>

Returns

Map<string, string>

Defined in

packages/framework/store/src/transformer/job.ts:306


assets

get assets(): Map<string, Blob>

Returns

Map<string, Blob>

Defined in

packages/framework/store/src/transformer/job.ts:310


assetsManager

get assetsManager(): AssetsManager

Returns

AssetsManager

Defined in

packages/framework/store/src/transformer/job.ts:314


collection

get collection(): DocCollection

Returns

DocCollection

Defined in

packages/framework/store/src/transformer/job.ts:318

Methods

blockToSnapshot()

blockToSnapshot(model): Promise<undefined | BlockSnapshot>

Parameters

model: DraftModel

Returns

Promise<undefined | BlockSnapshot>

Defined in

packages/framework/store/src/transformer/job.ts:56


collectionInfoToSnapshot()

collectionInfoToSnapshot(): undefined | CollectionInfoSnapshot

Returns

undefined | CollectionInfoSnapshot

Defined in

packages/framework/store/src/transformer/job.ts:71


docToSnapshot()

docToSnapshot(doc): Promise<undefined | DocSnapshot>

Parameters

doc: Doc

Returns

Promise<undefined | DocSnapshot>

Defined in

packages/framework/store/src/transformer/job.ts:96


reset()

reset(): void

Returns

void

Defined in

packages/framework/store/src/transformer/job.ts:523


sliceToSnapshot()

sliceToSnapshot(slice): Promise<undefined | SliceSnapshot>

Parameters

slice: Slice

Returns

Promise<undefined | SliceSnapshot>

Defined in

packages/framework/store/src/transformer/job.ts:134


snapshotToBlock()

snapshotToBlock(snapshot, doc, parent?, index?): Promise<undefined | BlockModel<object, SignaledProps<object>>>

Parameters

snapshot: BlockSnapshot

doc: Doc

parent?: string

index?: number

Returns

Promise<undefined | BlockModel<object, SignaledProps<object>>>

Defined in

packages/framework/store/src/transformer/job.ts:175


snapshotToDoc()

snapshotToDoc(snapshot): Promise<undefined | Doc>

Parameters

snapshot: DocSnapshot

Returns

Promise<undefined | Doc>

Defined in

packages/framework/store/src/transformer/job.ts:198


snapshotToModelData()

snapshotToModelData(snapshot): Promise<undefined | SnapshotReturn<object>>

Parameters

snapshot: BlockSnapshot

Returns

Promise<undefined | SnapshotReturn<object>>

Defined in

packages/framework/store/src/transformer/job.ts:223


snapshotToSlice()

snapshotToSlice(snapshot, doc, parent?, index?): Promise<undefined | Slice>

Parameters

snapshot: SliceSnapshot

doc: Doc

parent?: string

index?: number

Returns

Promise<undefined | Slice>

Defined in

packages/framework/store/src/transformer/job.ts:248


walk()

walk(snapshot, callback): void

Parameters

snapshot: DocSnapshot

callback

Returns

void

Defined in

packages/framework/store/src/transformer/job.ts:289