BlockSuite API Documentation / @blocksuite/affine-block-root / TemplateJob

Class: TemplateJob

Defined in: packages/affine/blocks/block-root/src/edgeless/services/template.ts:66

Constructors

new TemplateJob()

new TemplateJob(__namedParameters): TemplateJob

Defined in: packages/affine/blocks/block-root/src/edgeless/services/template.ts:88

Parameters

__namedParameters

TemplateJobConfig

Returns

TemplateJob

Properties

job

job: Transformer

Defined in: packages/affine/blocks/block-root/src/edgeless/services/template.ts:71

---

model

model: SurfaceBlockModel

Defined in: packages/affine/blocks/block-root/src/edgeless/services/template.ts:73

---

slots

slots: object

Defined in: packages/affine/blocks/block-root/src/edgeless/services/template.ts:75

beforeInsert

beforeInsert: Subject<SlotBlockPayload | { bound: null | Bound; template: DocSnapshot; type: "template"; }>

---

type

type: "template" | "sticker"

Defined in: packages/affine/blocks/block-root/src/edgeless/services/template.ts:86

---

middlewares

static middlewares: (job) => void[] = []

Defined in: packages/affine/blocks/block-root/src/edgeless/services/template.ts:67

Parameters

job

TemplateJob

Returns

void

Methods

insertTemplate()

insertTemplate(template): Promise<null | Bound>

Defined in: packages/affine/blocks/block-root/src/edgeless/services/template.ts:334

Parameters

template

unknown

Returns

Promise<null | Bound>

---

walk()

walk(callback): void

Defined in: packages/affine/blocks/block-root/src/edgeless/services/template.ts:356

Parameters

callback

(block, template) => void

Returns

void

---

create()

static create(options): TemplateJob

Defined in: packages/affine/blocks/block-root/src/edgeless/services/template.ts:99

Parameters

options

middlewares

(job) => void[]

model

SurfaceBlockModel

type

string

Returns

TemplateJob