@vtj

---

@vtj / renderer / BaseService

Class: BaseService

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

Extended by

• StorageService
• MemoryService
• LocalService

Implements

• Service

Constructors

new BaseService()

new BaseService(req?): BaseService

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

Parameters

req?

IStaticRequest

Returns

BaseService

Properties

api()

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

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

Parameters

type

string

data

any

Returns

Promise<any>

---

uploader()

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

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

Parameters

file

File

projectId

string

Returns

Promise<StaticFileInfo>

Methods

clearStaticFiles()

clearStaticFiles(projectId): Promise<boolean>

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

Parameters

projectId

string

Returns

Promise<boolean>

Implementation of

Service.clearStaticFiles

---

createRawPage()

createRawPage(file): Promise<boolean>

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

Parameters

file

PageFile

Returns

Promise<boolean>

Implementation of

Service.createRawPage

---

genSource()

genSource(project): Promise<string>

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

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:24

Parameters

project

ProjectSchema

dsl

BlockSchema

Returns

Promise<string>

Implementation of

Service.genVueContent

---

getExtension()

getExtension(): Promise<undefined | ExtensionConfig>

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

Returns

Promise<undefined | ExtensionConfig>

Implementation of

Service.getExtension

---

getFile()

getFile(id): Promise<BlockSchema>

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

Parameters

id

string

Returns

Promise<BlockSchema>

Implementation of

Service.getFile

---

getHistory()

getHistory(id): Promise<HistorySchema>

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

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:19

Parameters

fId

string

id

string

Returns

Promise<HistoryItem>

Implementation of

Service.getHistoryItem

---

getPluginMaterial()

getPluginMaterial(from): Promise<null | MaterialDescription>

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

Parameters

from

NodeFromPlugin

Returns

Promise<null | MaterialDescription>

Implementation of

Service.getPluginMaterial

---

getStaticFiles()

getStaticFiles(projectId): Promise<StaticFileInfo[]>

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

Parameters

projectId

string

Returns

Promise<StaticFileInfo[]>

Implementation of

Service.getStaticFiles

---

init()

init(project): Promise<ProjectSchema>

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

Parameters

project

ProjectSchema

Returns

Promise<ProjectSchema>

Implementation of

Service.init

---

publish()

publish(project): Promise<boolean>

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

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:23

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:15

Parameters

id

string

Returns

Promise<boolean>

Implementation of

Service.removeFile

---

removeHistory()

removeHistory(id): Promise<boolean>

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

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:21

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:26

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:29

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:13

Parameters

file

BlockSchema

Returns

Promise<boolean>

Implementation of

Service.saveFile

---

saveHistory()

saveHistory(history): Promise<boolean>

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

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:20

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:12

Parameters

project

ProjectSchema

materials

Map<string, MaterialDescription>

Returns

Promise<boolean>

Implementation of

Service.saveMaterials

---

saveProject()

saveProject(project): Promise<boolean>

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

Parameters

project

ProjectSchema

Returns

Promise<boolean>

Implementation of

Service.saveProject

---

uploadStaticFile()

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

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

Parameters

file

File

projectId

string

Returns

Promise<null | StaticFileInfo>

Implementation of

Service.uploadStaticFile