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:342

Accessors

adapterConfigs

Get Signature

get adapterConfigs(): Map<string, string>

Returns

Map<string, string>

Defined in

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


assets

Get Signature

get assets(): Map<string, Blob>

Returns

Map<string, Blob>

Defined in

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


assetsManager

Get Signature

get assetsManager(): AssetsManager

Returns

AssetsManager

Defined in

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


collection

Get Signature

get collection(): DocCollection

Returns

DocCollection

Defined in

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

Methods

blockToSnapshot()

blockToSnapshot(model): undefined | BlockSnapshot

Parameters

model

DraftModel

Returns

undefined | BlockSnapshot

Defined in

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


collectionInfoToSnapshot()

collectionInfoToSnapshot(): undefined | CollectionInfoSnapshot

Returns

undefined | CollectionInfoSnapshot

Defined in

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


docToSnapshot()

docToSnapshot(doc): undefined | DocSnapshot

Parameters

doc

Doc

Returns

undefined | DocSnapshot

Defined in

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


reset()

reset(): void

Returns

void

Defined in

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


sliceToSnapshot()

sliceToSnapshot(slice): undefined | SliceSnapshot

Parameters

slice

Slice

Returns

undefined | SliceSnapshot

Defined in

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


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:180


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 | SnapshotNode<object>>

Parameters

snapshot

BlockSnapshot

Returns

Promise<undefined | SnapshotNode<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

(block) => void

Returns

void

Defined in

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