@vtj • Docs

---

@vtj / core / ProjectModel

Class: ProjectModel

Constructors

new ProjectModel()

new ProjectModel(schema): ProjectModel

Parameters

• schema: ProjectSchema

Returns

ProjectModel

Defined in

packages/core/src/models/project.ts:89

Properties

__BASE_PATH__

__BASE_PATH__: string = '/'

Defined in

packages/core/src/models/project.ts:76

---

apis

apis: ApiSchema[] = []

Defined in

packages/core/src/models/project.ts:72

---

blocks

blocks: BlockFile[] = []

Defined in

packages/core/src/models/project.ts:71

---

config

config: ProjectConfig = {}

Defined in

packages/core/src/models/project.ts:75

---

currentFile

currentFile: null | BlockFile | PageFile = null

Defined in

packages/core/src/models/project.ts:74

---

dependencies

dependencies: Dependencie[] = []

Defined in

packages/core/src/models/project.ts:69

---

description

description: string = ''

Defined in

packages/core/src/models/project.ts:67

---

homepage

homepage: string = ''

Defined in

packages/core/src/models/project.ts:68

---

id

id: string = ''

Defined in

packages/core/src/models/project.ts:65

---

meta

meta: MetaSchema[] = []

Defined in

packages/core/src/models/project.ts:73

---

name

name: string = ''

Defined in

packages/core/src/models/project.ts:66

---

pages

pages: PageFile[] = []

Defined in

packages/core/src/models/project.ts:70

---

attrs

static attrs: string[]

Defined in

packages/core/src/models/project.ts:77

Methods

active()

active(file, silent): void

打开文件

Parameters

• file: BlockFile | PageFile

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:157

---

cleanPagesDsl()

cleanPagesDsl(files): void

Parameters

• files: PageFile[]

Returns

void

Defined in

packages/core/src/models/project.ts:114

---

clonePage()

clonePage(page, parentId?, silent?): void

复制页面

Parameters

• page: PageFile

• parentId?: string

• silent?: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:363

---

createBlock()

createBlock(block, silent): Promise<void>

创建区块

Parameters

• block: BlockFile

• silent: boolean = false

Returns

Promise<void>

Defined in

packages/core/src/models/project.ts:444

---

createPage()

createPage(page, parentId?, silent?): Promise<void>

新建页面

Parameters

• page: PageFile

• parentId?: string

• silent?: boolean = false

Returns

Promise<void>

Defined in

packages/core/src/models/project.ts:287

---

deactivate()

deactivate(silent): void

关闭文件

Parameters

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:171

---

existApiName()

existApiName(name, excludes): boolean

Parameters

• name: string

• excludes: string[] = []

Returns

boolean

Defined in

packages/core/src/models/project.ts:598

---

existBlockName()

existBlockName(name, excludes): boolean

检查是否存在名称的区块

Parameters

• name: string

• excludes: string[] = []

Returns

boolean

Defined in

packages/core/src/models/project.ts:529

---

existMetaCode()

existMetaCode(code, excludes): boolean

Parameters

• code: string

• excludes: string[] = []

Returns

boolean

Defined in

packages/core/src/models/project.ts:645

---

existPageName()

existPageName(name, excludes): boolean

检测是否存在名称的页面

Parameters

• name: string

• excludes: string[] = []

Returns

boolean

Defined in

packages/core/src/models/project.ts:541

---

getBlock()

getBlock(id): undefined | BlockFile

获取区块文件

Parameters

• id: string

Returns

undefined | BlockFile

Defined in

packages/core/src/models/project.ts:435

---

getPage()

getPage(id): undefined | PageFile

根据页面id查找页面或目录

Parameters

• id: string

Returns

undefined | PageFile

Defined in

packages/core/src/models/project.ts:239

---

getPages()

getPages(): PageFile[]

查找全部页面，不含目录

Returns

PageFile[]

Defined in

packages/core/src/models/project.ts:264

---

isPageFile()

isPageFile(file): file is PageFile

Parameters

• file: BlockFile | PageFile

Returns

file is PageFile

Defined in

packages/core/src/models/project.ts:110

---

publish()

publish(file?): void

Parameters

• file?: BlockFile | PageFile

Returns

void

Defined in

packages/core/src/models/project.ts:673

---

removeApi()

removeApi(name, silent): void

删除api

Parameters

• name: string

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:580

---

removeBlock()

removeBlock(id, silent): void

删除区块

Parameters

• id: string

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:500

---

removeDeps()

removeDeps(item, silent): void

删除依赖

Parameters

• item: Dependencie

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:217

---

removeMeta()

removeMeta(code, silent): void

Parameters

• code: string

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:627

---

removePage()

removePage(id, silent): void

删除页面或目录

Parameters

• id: string

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:398

---

setApi()

setApi(item, silent): void

新增或更新api

Parameters

• item: ApiSchema

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:551

---

setConfig()

setConfig(config, silent): void

Parameters

• config: ProjectConfig

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:661

---

setDeps()

setDeps(item, silent): void

新增或更新依赖

Parameters

• item: Dependencie

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:187

---

setHomepage()

setHomepage(id, silent): void

Parameters

• id: string

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:649

---

setMeta()

setMeta(item, silent): void

Parameters

• item: MetaSchema

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:602

---

toDsl()

toDsl(_version?): ProjectSchema

Parameters

• _version?: string

Returns

ProjectSchema

Defined in

packages/core/src/models/project.ts:123

---

update()

update(schema, silent): void

Parameters

• schema: Partial<ProjectSchema>

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:95

---

updateBlock()

updateBlock(block, silent): void

Parameters

• block: BlockFile

更新区块

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:474

---

updatePage()

updatePage(page, silent): void

更新页面

Parameters

• page: PageFile

• silent: boolean = false

Returns

void

Defined in

packages/core/src/models/project.ts:339