BlockSuite API Documentation / @blocksuite/store / Job

Class: Job

Constructors

new Job(__namedParameters)

new Job(__namedParameters): Job

Parameters

• __namedParameters: JobConfig

Returns

Job

Source

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

Properties

_adapterConfigs

private readonly _adapterConfigs: Map<string, string>

Source

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

---

_assetsManager

private readonly _assetsManager: AssetsManager

Source

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

---

_collection

private readonly _collection: DocCollection

Source

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

---

_slots

private readonly _slots: JobSlots

Source

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

Accessors

adapterConfigs

get adapterConfigs(): Map<string, string>

Returns

Map<string, string>

Source

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

---

assets

get assets(): Map<string, Blob>

Returns

Map<string, Blob>

Source

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

---

assetsManager

get assetsManager(): AssetsManager

Returns

AssetsManager

Source

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

Methods

_blockToSnapshot()

private _blockToSnapshot(model): Promise<BlockSnapshot>

Parameters

• model: DraftModel

Returns

Promise<BlockSnapshot>

Source

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

---

_exportDocMeta()

private _exportDocMeta(doc): DocMeta

Parameters

• doc: Doc

Returns

DocMeta

Source

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

---

_getCollectionMeta()

private _getCollectionMeta(): object

Returns

object

pageVersion

pageVersion: number

pages

pages: DocMeta[]

properties

properties: DocsPropertiesMeta

workspaceVersion

workspaceVersion: number

Source

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

---

_getSchema()

private _getSchema(flavour): object

Parameters

• flavour: string

Returns

object

model

model: object

model.children?

optional children: string[] = ContentSchema

model.flavour

flavour: string = FlavourSchema

model.parent?

optional parent: string[] = ParentSchema

model.props()?

optional props: (...args) => Record<string, any>

Parameters

• ...args: [InternalPrimitives, ...unknown[]]

Returns

Record<string, any>

model.role

role: "root" | "hub" | "content" = RoleSchema

model.toModel()?

optional toModel: (...args) => BlockModel<object>

Parameters

• ...args: unknown[]

Returns

BlockModel<object>

onUpgrade()?

optional onUpgrade: (...args) => void

Parameters

• ...args: [any, number, number, ...unknown[]]

Returns

void

transformer()?

optional transformer: (...args) => BaseBlockTransformer<object>

Parameters

• ...args: unknown[]

Returns

BaseBlockTransformer<object>

version

version: number

Source

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

---

_getTransformer()

private _getTransformer(schema): BaseBlockTransformer<object>

Parameters

• schema

• schema.model= undefined

• schema.model.children?: string[]= ContentSchema

• schema.model.flavour: string= FlavourSchema

• schema.model.parent?: string[]= ParentSchema

• schema.model.props?= undefined

• schema.model.role: "root" | "hub" | "content"= RoleSchema

• schema.model.toModel?= undefined

• schema.onUpgrade?= undefined

• schema.transformer?= undefined

• schema.version: number= undefined

Returns

BaseBlockTransformer<object>

Source

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

---

_importDocMeta()

private _importDocMeta(doc, meta): void

Parameters

• doc: Doc

• meta: DocMeta

Returns

void

Source

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

---

_snapshotToBlock()

private _snapshotToBlock(snapshot, doc, parent?, index?): Promise<BlockModel<object>>

Parameters

• snapshot: BlockSnapshot

• doc: Doc

• parent?: string

• index?: number

Returns

Promise<BlockModel<object>>

Source

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

---

blockToSnapshot()

blockToSnapshot(model): Promise<BlockSnapshot>

Parameters

• model: DraftModel

Returns

Promise<BlockSnapshot>

Source

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

---

collectionInfoToSnapshot()

collectionInfoToSnapshot(): CollectionInfoSnapshot

Returns

CollectionInfoSnapshot

Source

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

---

docToSnapshot()

docToSnapshot(doc): Promise<DocSnapshot>

Parameters

• doc: Doc

Returns

Promise<DocSnapshot>

Source

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

---

reset()

reset(): void

Returns

void

Source

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

---

sliceToSnapshot()

sliceToSnapshot(slice): Promise<SliceSnapshot>

Parameters

• slice: Slice

Returns

Promise<SliceSnapshot>

Source

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

---

snapshotToBlock()

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

Parameters

• snapshot: BlockSnapshot

• doc: Doc

• parent?: string

• index?: number

Returns

Promise<BlockModel<object>>

Source

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

---

snapshotToCollectionInfo()

snapshotToCollectionInfo(snapshot): void

Parameters

• snapshot: CollectionInfoSnapshot

Returns

void

Source

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

---

snapshotToDoc()

snapshotToDoc(snapshot): Promise<Doc>

Parameters

• snapshot: DocSnapshot

Returns

Promise<Doc>

Source

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

---

snapshotToModelData()

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

Parameters

• snapshot: BlockSnapshot

Returns

Promise<SnapshotReturn<object>>

Source

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

---

snapshotToSlice()

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

Parameters

• snapshot: SliceSnapshot

• doc: Doc

• parent?: string

• index?: number

Returns

Promise<Slice>

Source

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

---

walk()

walk(snapshot, callback): void

Parameters

• snapshot: DocSnapshot

• callback

Returns

void

Source

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