@vtj • Docs

---

@vtj / core / Service

Class: abstract Service

Constructors

new Service()

new Service(): Service

Returns

Service

Methods

clearStaticFiles()

abstract clearStaticFiles(projectId): Promise<boolean>

Parameters

• projectId: string

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:58

---

createRawPage()

abstract createRawPage(file): Promise<boolean>

Parameters

• file: PageFile

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:46

---

genVueContent()

abstract genVueContent(project, dsl): Promise<string>

Parameters

• project: ProjectSchema

• dsl: BlockSchema

Returns

Promise<string>

Defined in

packages/core/src/protocols/service.ts:41

---

getExtension()

abstract getExtension(): Promise<undefined | ExtensionConfig>

Returns

Promise<undefined | ExtensionConfig>

Defined in

packages/core/src/protocols/service.ts:14

---

getFile()

abstract getFile(id): Promise<BlockSchema>

Parameters

• id: string

Returns

Promise<BlockSchema>

Defined in

packages/core/src/protocols/service.ts:22

---

getHistory()

abstract getHistory(id): Promise<HistorySchema>

Parameters

• id: string

Returns

Promise<HistorySchema>

Defined in

packages/core/src/protocols/service.ts:26

---

getHistoryItem()

abstract getHistoryItem(fId, id): Promise<HistoryItem>

Parameters

• fId: string

• id: string

Returns

Promise<HistoryItem>

Defined in

packages/core/src/protocols/service.ts:27

---

getPluginMaterial()

abstract getPluginMaterial(from): Promise<null | MaterialDescription>

Parameters

• from: NodeFromPlugin

Returns

Promise<null | MaterialDescription>

Defined in

packages/core/src/protocols/service.ts:60

---

getStaticFiles()

abstract getStaticFiles(projectId): Promise<StaticFileInfo[]>

Parameters

• projectId: string

Returns

Promise<StaticFileInfo[]>

Defined in

packages/core/src/protocols/service.ts:53

---

init()

abstract init(project): Promise<ProjectSchema>

Parameters

• project: ProjectSchema

Returns

Promise<ProjectSchema>

Defined in

packages/core/src/protocols/service.ts:15

---

publish()

abstract publish(project): Promise<boolean>

Parameters

• project: ProjectSchema

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:36

---

publishFile()

abstract publishFile(project, file): Promise<boolean>

Parameters

• project: ProjectSchema

• file: BlockFile | PageFile

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:37

---

removeFile()

abstract removeFile(id): Promise<boolean>

Parameters

• id: string

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:23

---

removeHistory()

abstract removeHistory(id): Promise<boolean>

Parameters

• id: string

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:25

---

removeHistoryItem()

abstract removeHistoryItem(fId, ids): Promise<boolean>

Parameters

• fId: string

• ids: string[]

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:32

---

removeRawPage()

abstract removeRawPage(id): Promise<boolean>

Parameters

• id: string

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:47

---

removeStaticFile()

abstract removeStaticFile(name, projectId): Promise<boolean>

Parameters

• name: string

• projectId: string

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:54

---

saveFile()

abstract saveFile(file): Promise<boolean>

Parameters

• file: BlockSchema

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:21

---

saveHistory()

abstract saveHistory(history): Promise<boolean>

Parameters

• history: HistorySchema

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:24

---

saveHistoryItem()

abstract saveHistoryItem(fId, item): Promise<boolean>

Parameters

• fId: string

• item: HistoryItem

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:28

---

saveMaterials()

abstract saveMaterials(project, materials): Promise<boolean>

Parameters

• project: ProjectSchema

• materials: Map<string, MaterialDescription>

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:17

---

saveProject()

abstract saveProject(project): Promise<boolean>

Parameters

• project: ProjectSchema

Returns

Promise<boolean>

Defined in

packages/core/src/protocols/service.ts:16

---

uploadStaticFile()

abstract uploadStaticFile(file, projectId): Promise<null | StaticFileInfo>

Parameters

• file: File

• projectId: string

Returns

Promise<null | StaticFileInfo>

Defined in

packages/core/src/protocols/service.ts:49