@vtj

---

@vtj / renderer / BaseService

Class: BaseService

Defined in: packages/renderer/types/services/base.d.ts:4

Extended by

• StorageService
• MemoryService
• LocalService

Implements

• Service

Constructors

Constructor

new BaseService(req?): BaseService

Defined in: packages/renderer/types/services/base.d.ts:9

Parameters

req?

IStaticRequest<any, any>

Returns

BaseService

Properties

api()

protected api: (type, data, query?) => Promise<any>

Defined in: packages/renderer/types/services/base.d.ts:6

Parameters

type

string

data

any

query?

any

Returns

Promise<any>

---

req

req: IStaticRequest

Defined in: packages/renderer/types/services/base.d.ts:5

---

uploader()

protected uploader: (file, projectId) => Promise<StaticFileInfo>

Defined in: packages/renderer/types/services/base.d.ts:8

Parameters

file

File

projectId

string

Returns

Promise<StaticFileInfo>

Methods

clearStaticFiles()

clearStaticFiles(projectId): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:32

删除全部静态文件

Parameters

projectId

string

Returns

Promise<boolean>

Implementation of

Service.clearStaticFiles

---

createRawPage()

createRawPage(file): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:27

创建源码模式的文件

Parameters

file

PageFile

Returns

Promise<boolean>

Implementation of

Service.createRawPage

---

genSource()

genSource(project): Promise<string>

Defined in: packages/renderer/types/services/base.d.ts:34

项目出码，导出zip

Parameters

project

ProjectSchema

Returns

Promise<string>

Implementation of

Service.genSource

---

genVueContent()

genVueContent(project, dsl): Promise<string>

Defined in: packages/renderer/types/services/base.d.ts:25

文件DSL转Vue源码

Parameters

project

ProjectSchema

dsl

BlockSchema

Returns

Promise<string>

Implementation of

Service.genVueContent

---

getExtension()

getExtension(): Promise<VTJConfig | undefined>

Defined in: packages/renderer/types/services/base.d.ts:10

获取低代码设计器配置

Returns

Promise<VTJConfig | undefined>

Implementation of

Service.getExtension

---

getFile()

getFile(id): Promise<BlockSchema>

Defined in: packages/renderer/types/services/base.d.ts:15

获取页面文件

Parameters

id

string

Returns

Promise<BlockSchema>

Implementation of

Service.getFile

---

getHistory()

getHistory(id): Promise<HistorySchema>

Defined in: packages/renderer/types/services/base.d.ts:19

获取历史记录

Parameters

id

string

Returns

Promise<HistorySchema>

Implementation of

Service.getHistory

---

getHistoryItem()

getHistoryItem(fId, id): Promise<HistoryItem>

Defined in: packages/renderer/types/services/base.d.ts:20

获取历史记录项

Parameters

fId

string

id

string

Returns

Promise<HistoryItem>

Implementation of

Service.getHistoryItem

---

getPluginMaterial()

getPluginMaterial(from): Promise<MaterialDescription | null>

Defined in: packages/renderer/types/services/base.d.ts:33

获取插件的物料

Parameters

from

NodeFromPlugin

Returns

Promise<MaterialDescription | null>

Implementation of

Service.getPluginMaterial

---

getStaticFiles()

getStaticFiles(projectId): Promise<StaticFileInfo[]>

Defined in: packages/renderer/types/services/base.d.ts:30

Parameters

projectId

string

Returns

Promise<StaticFileInfo[]>

Implementation of

Service.getStaticFiles

---

init()

init(project): Promise<ProjectSchema>

Defined in: packages/renderer/types/services/base.d.ts:11

获取完整的项目信息

Parameters

project

ProjectSchema

Returns

Promise<ProjectSchema>

Implementation of

Service.init

---

parseVue()

parseVue(project, options): Promise<BlockSchema>

Defined in: packages/renderer/types/services/base.d.ts:26

Vue源码转DSL

Parameters

project

ProjectSchema

options

ParseVueOptions

Returns

Promise<BlockSchema>

Implementation of

Service.parseVue

---

publish()

publish(project): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:23

发布项目，整站出码

Parameters

project

ProjectSchema

Returns

Promise<boolean>

Implementation of

Service.publish

---

publishFile()

publishFile(project, file): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:24

发布页面，单个页面出码

Parameters

project

ProjectSchema

file

PageFile | BlockFile

Returns

Promise<boolean>

Implementation of

Service.publishFile

---

removeFile()

removeFile(id): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:16

删除文件

Parameters

id

string

Returns

Promise<boolean>

Implementation of

Service.removeFile

---

removeHistory()

removeHistory(id): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:18

删除历史记录

Parameters

id

string

Returns

Promise<boolean>

Implementation of

Service.removeHistory

---

removeHistoryItem()

removeHistoryItem(fId, ids): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:22

删除历史记录项

Parameters

fId

string

ids

string[]

Returns

Promise<boolean>

Implementation of

Service.removeHistoryItem

---

removeRawPage()

removeRawPage(id): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:28

删除源码模式的文件

Parameters

id

string

Returns

Promise<boolean>

Implementation of

Service.removeRawPage

---

removeStaticFile()

removeStaticFile(name, projectId): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:31

删除静态文件

Parameters

name

string

projectId

string

Returns

Promise<boolean>

Implementation of

Service.removeStaticFile

---

saveFile()

saveFile(file): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:14

保存页面文件

Parameters

file

BlockSchema

Returns

Promise<boolean>

Implementation of

Service.saveFile

---

saveHistory()

saveHistory(history): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:17

保存历史记录

Parameters

history

HistorySchema

Returns

Promise<boolean>

Implementation of

Service.saveHistory

---

saveHistoryItem()

saveHistoryItem(fId, item): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:21

保存历史记录项

Parameters

fId

string

item

HistoryItem

Returns

Promise<boolean>

Implementation of

Service.saveHistoryItem

---

saveMaterials()

saveMaterials(project, materials): Promise<boolean>

Defined in: packages/renderer/types/services/base.d.ts:13

保存项目的物料信息

Parameters

project

ProjectSchema

materials

Map<string, MaterialDescription>

Returns

Promise<boolean>

Implementation of

Service.saveMaterials

---

saveProject()

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

Defined in: packages/renderer/types/services/base.d.ts:12

保存项目信息

Parameters

project

ProjectSchema

type?

string

Returns

Promise<boolean>

Implementation of

Service.saveProject

---

uploadStaticFile()

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

Defined in: packages/renderer/types/services/base.d.ts:29

上传静态文件

Parameters

file

File

projectId

string

Returns

Promise<StaticFileInfo | null>

Implementation of

Service.uploadStaticFile