@vtj

---

@vtj / core / ProjectModel

Class: ProjectModel

Defined in: packages/core/src/models/project.ts:80

Constructors

Constructor

new ProjectModel(schema): ProjectModel

Defined in: packages/core/src/models/project.ts:115

Parameters

schema

ProjectSchema

Returns

ProjectModel

Properties

__BASE_PATH__

__BASE_PATH__: string = '/'

Defined in: packages/core/src/models/project.ts:96

---

__UID__

__UID__: string

Defined in: packages/core/src/models/project.ts:97

---

apis

apis: ApiSchema[] = []

Defined in: packages/core/src/models/project.ts:90

---

blocks

blocks: BlockFile[] = []

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

---

config

config: ProjectConfig = {}

Defined in: packages/core/src/models/project.ts:93

---

currentFile

currentFile: null | BlockFile | PageFile = null

Defined in: packages/core/src/models/project.ts:92

---

dependencies

dependencies: Dependencie[] = []

Defined in: packages/core/src/models/project.ts:87

---

description

description: string = ''

Defined in: packages/core/src/models/project.ts:85

---

globals

globals: GlobalConfig = {}

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

---

homepage

homepage: string = ''

Defined in: packages/core/src/models/project.ts:86

---

id

id: string = ''

Defined in: packages/core/src/models/project.ts:81

---

locked

locked: string = ''

Defined in: packages/core/src/models/project.ts:82

---

meta

meta: MetaSchema[] = []

Defined in: packages/core/src/models/project.ts:91

---

name

name: string = ''

Defined in: packages/core/src/models/project.ts:84

---

pages

pages: PageFile[] = []

Defined in: packages/core/src/models/project.ts:88

---

platform

platform: PlatformType = 'web'

Defined in: packages/core/src/models/project.ts:83

---

uniConfig

uniConfig: UniConfig = {}

Defined in: packages/core/src/models/project.ts:94

---

attrs

static attrs: string[]

Defined in: packages/core/src/models/project.ts:98

Methods

active()

active(file, silent): void

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

打开文件

Parameters

file

BlockFile | PageFile

silent

boolean = false

Returns

void

---

cleanPagesDsl()

cleanPagesDsl(files): void

Defined in: packages/core/src/models/project.ts:141

Parameters

files

PageFile[]

Returns

void

---

cloneBlock()

cloneBlock(block, silent): void

Defined in: packages/core/src/models/project.ts:566

Parameters

block

BlockFile

silent

boolean = false

Returns

void

---

clonePage()

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

Defined in: packages/core/src/models/project.ts:397

复制页面

Parameters

page

PageFile

parentId?

string

silent?

boolean = false

Returns

void

---

createBlock()

createBlock(block, silent): Promise<void>

Defined in: packages/core/src/models/project.ts:515

创建区块

Parameters

block

BlockFile

silent

boolean = false

Returns

Promise<void>

---

createPage()

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

Defined in: packages/core/src/models/project.ts:320

新建页面

Parameters

page

PageFile

parentId?

string

silent?

boolean = false

Returns

Promise<void>

---

deactivate()

deactivate(silent): void

Defined in: packages/core/src/models/project.ts:201

关闭文件

Parameters

silent

boolean = false

Returns

void

---

existApiName()

existApiName(name, excludes): boolean

Defined in: packages/core/src/models/project.ts:711

Parameters

name

string

excludes

string[] = []

Returns

boolean

---

existBlockName()

existBlockName(name, excludes): boolean

Defined in: packages/core/src/models/project.ts:626

检查是否存在名称的区块

Parameters

name

string

excludes

string[] = []

Returns

boolean

---

existMetaCode()

existMetaCode(code, excludes): boolean

Defined in: packages/core/src/models/project.ts:758

Parameters

code

string

excludes

string[] = []

Returns

boolean

---

existPageName()

existPageName(name, excludes): boolean

Defined in: packages/core/src/models/project.ts:638

检测是否存在名称的页面

Parameters

name

string

excludes

string[] = []

Returns

boolean

---

genSource()

genSource(): void

Defined in: packages/core/src/models/project.ts:831

Returns

void

---

getBlock()

getBlock(id): undefined | BlockFile

Defined in: packages/core/src/models/project.ts:502

获取区块文件

Parameters

id

string

Returns

undefined | BlockFile

---

getFile()

getFile(id): undefined | BlockFile | PageFile

Defined in: packages/core/src/models/project.ts:506

Parameters

id

string

Returns

undefined | BlockFile | PageFile

---

getPage()

getPage(id): undefined | PageFile

Defined in: packages/core/src/models/project.ts:269

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

Parameters

id

string

Returns

undefined | PageFile

---

getPageRoutes()

getPageRoutes(pageRouteName?, pageBasePath?): object[]

Defined in: packages/core/src/models/project.ts:861

Parameters

pageRouteName?

string

pageBasePath?

string

Returns

object[]

---

getPages()

getPages(): PageFile[]

Defined in: packages/core/src/models/project.ts:294

查找全部页面，不含目录

Returns

PageFile[]

---

isPageFile()

isPageFile(file): file is PageFile

Defined in: packages/core/src/models/project.ts:137

Parameters

file

BlockFile | PageFile

Returns

file is PageFile

---

lock()

lock(id): void

Defined in: packages/core/src/models/project.ts:840

Parameters

id

string

Returns

void

---

publish()

publish(file?): void

Defined in: packages/core/src/models/project.ts:818

Parameters

file?

BlockFile | PageFile

Returns

void

---

removeApi()

removeApi(name, silent): void

Defined in: packages/core/src/models/project.ts:693

删除api

Parameters

name

string

silent

boolean = false

Returns

void

---

removeBlock()

removeBlock(id, silent): void

Defined in: packages/core/src/models/project.ts:597

删除区块

Parameters

id

string

silent

boolean = false

Returns

void

---

removeDeps()

removeDeps(item, silent): void

Defined in: packages/core/src/models/project.ts:247

删除依赖

Parameters

item

Dependencie

silent

boolean = false

Returns

void

---

removeMeta()

removeMeta(code, silent): void

Defined in: packages/core/src/models/project.ts:740

Parameters

code

string

silent

boolean = false

Returns

void

---

removePage()

removePage(id, silent): void

Defined in: packages/core/src/models/project.ts:465

删除页面或目录

Parameters

id

string

silent

boolean = false

Returns

void

---

saveToBlock()

saveToBlock(page, silent): Promise<void>

Defined in: packages/core/src/models/project.ts:427

Parameters

page

PageFile

silent

boolean = false

Returns

Promise<void>

---

setApi()

setApi(item, silent): void

Defined in: packages/core/src/models/project.ts:648

新增或更新api

Parameters

item

ApiSchema

silent

boolean = false

Returns

void

---

setApis()

setApis(items, silent): void

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

Parameters

items

ApiSchema[]

silent

boolean = false

Returns

void

---

setConfig()

setConfig(config, silent): void

Defined in: packages/core/src/models/project.ts:774

Parameters

config

ProjectConfig

silent

boolean = false

Returns

void

---

setDeps()

setDeps(item, silent): void

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

新增或更新依赖

Parameters

item

Dependencie

silent

boolean = false

Returns

void

---

setGloblas()

setGloblas(key, value, silent): void

Defined in: packages/core/src/models/project.ts:802

Parameters

key

keyof GlobalConfig

value

string | JSFunction

silent

boolean = false

Returns

void

---

setHomepage()

setHomepage(id, silent): void

Defined in: packages/core/src/models/project.ts:762

Parameters

id

string

silent

boolean = false

Returns

void

---

setMeta()

setMeta(item, silent): void

Defined in: packages/core/src/models/project.ts:715

Parameters

item

MetaSchema

silent

boolean = false

Returns

void

---

setUniConfig()

setUniConfig(key, value, silent): void

Defined in: packages/core/src/models/project.ts:786

Parameters

key

keyof UniConfig

value

Record<string, any>

silent

boolean = false

Returns

void

---

toDsl()

toDsl(_version?): ProjectSchema

Defined in: packages/core/src/models/project.ts:150

Parameters

_version?

string

Returns

ProjectSchema

---

unlock()

unlock(id): void

Defined in: packages/core/src/models/project.ts:849

Parameters

id

string

Returns

void

---

update()

update(schema, silent): void

Defined in: packages/core/src/models/project.ts:122

Parameters

schema

Partial<ProjectSchema>

silent

boolean = false

Returns

void

---

updateBlock()

updateBlock(block, silent): void

Defined in: packages/core/src/models/project.ts:545

Parameters

block

BlockFile

更新区块

silent

boolean = false

Returns

void

---

updatePage()

updatePage(page, silent): void

Defined in: packages/core/src/models/project.ts:372

更新页面

Parameters

page

PageFile

silent

boolean = false

Returns

void