@vtj

---

@vtj / core / Service

Abstract Class: Service

Defined in: packages/core/src/protocols/service.ts:13

Constructors

Constructor

new Service(): Service

Returns

Service

Methods

clearStaticFiles()

abstract clearStaticFiles(projectId): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:226

删除全部静态文件

Parameters

projectId

string

Returns

Promise<boolean>

---

createRawPage()

abstract createRawPage(file, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:184

创建源码模式的文件

Parameters

file

PageFile

project?

ProjectSchema

Returns

Promise<boolean>

---

genSource()

abstract genSource(project): Promise<string>

Defined in: packages/core/src/protocols/service.ts:241

项目出码，导出zip

Parameters

project

ProjectSchema

Returns

Promise<string>

---

genVueContent()

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

Defined in: packages/core/src/protocols/service.ts:164

文件DSL转Vue源码

Parameters

project

ProjectSchema

dsl

BlockSchema

Returns

Promise<string>

---

getExtension()

abstract getExtension(): Promise<VTJConfig | undefined>

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

获取低代码设计器配置

Returns

Promise<VTJConfig | undefined>

---

getFile()

abstract getFile(id, project?): Promise<BlockSchema>

Defined in: packages/core/src/protocols/service.ts:63

获取页面文件

Parameters

id

string

project?

ProjectSchema

Returns

Promise<BlockSchema>

---

getHistory()

abstract getHistory(id, project?): Promise<HistorySchema>

Defined in: packages/core/src/protocols/service.ts:103

获取历史记录

Parameters

id

string

project?

ProjectSchema

Returns

Promise<HistorySchema>

---

getHistoryItem()

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

Defined in: packages/core/src/protocols/service.ts:114

获取历史记录项

Parameters

fId

string

id

string

project?

ProjectSchema

Returns

Promise<HistoryItem>

---

getPluginMaterial()

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

Defined in: packages/core/src/protocols/service.ts:233

获取插件的物料

Parameters

from

NodeFromPlugin

Returns

Promise<MaterialDescription | null>

---

getStaticFiles()

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

Defined in: packages/core/src/protocols/service.ts:208

Parameters

projectId

string

Returns

Promise<StaticFileInfo[]>

---

init()

abstract init(project, isInit?): Promise<ProjectSchema>

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

获取完整的项目信息

Parameters

project

Partial<ProjectSchema>

isInit?

boolean

Returns

Promise<ProjectSchema>

---

parseVue()

abstract parseVue(project, options): Promise<BlockSchema>

Defined in: packages/core/src/protocols/service.ts:174

Vue源码转DSL

Parameters

project

ProjectSchema

options

ParseVueOptions

Returns

Promise<BlockSchema>

---

publish()

abstract publish(project): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:148

发布项目，整站出码

Parameters

project

ProjectSchema

Returns

Promise<boolean>

---

publishFile()

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

Defined in: packages/core/src/protocols/service.ts:154

发布页面，单个页面出码

Parameters

project

ProjectSchema

file

BlockFile | PageFile

Returns

Promise<boolean>

---

removeFile()

abstract removeFile(id, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:73

删除文件

Parameters

id

string

project?

ProjectSchema

Returns

Promise<boolean>

---

removeHistory()

abstract removeHistory(id, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:93

删除历史记录

Parameters

id

string

project?

ProjectSchema

Returns

Promise<boolean>

---

removeHistoryItem()

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

Defined in: packages/core/src/protocols/service.ts:138

删除历史记录项

Parameters

fId

string

ids

string[]

project?

ProjectSchema

Returns

Promise<boolean>

---

removeRawPage()

abstract removeRawPage(id, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:194

删除源码模式的文件

Parameters

id

string

project?

ProjectSchema

Returns

Promise<boolean>

---

removeStaticFile()

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

Defined in: packages/core/src/protocols/service.ts:215

删除静态文件

Parameters

name

string

projectId

string

file?

StaticFileInfo

Returns

Promise<boolean>

---

saveFile()

abstract saveFile(file, project?): Promise<boolean>

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

保存页面文件

Parameters

file

BlockSchema

project?

ProjectSchema

Returns

Promise<boolean>

---

saveHistory()

abstract saveHistory(history, project?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:83

保存历史记录

Parameters

history

HistorySchema

project?

ProjectSchema

Returns

Promise<boolean>

---

saveHistoryItem()

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

Defined in: packages/core/src/protocols/service.ts:126

保存历史记录项

Parameters

fId

string

item

HistoryItem

project?

ProjectSchema

Returns

Promise<boolean>

---

saveMaterials()

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

Defined in: packages/core/src/protocols/service.ts:43

保存项目的物料信息

Parameters

project

ProjectSchema

materials

Map<string, MaterialDescription>

Returns

Promise<boolean>

---

saveProject()

abstract saveProject(project, type?): Promise<boolean>

Defined in: packages/core/src/protocols/service.ts:33

保存项目信息

Parameters

project

ProjectSchema

type?

string

Returns

Promise<boolean>

---

uploadStaticFile()

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

Defined in: packages/core/src/protocols/service.ts:204

上传静态文件

Parameters

file

File

projectId

string

Returns

Promise<StaticFileInfo | null>