Class JsRouteConfigFile

路由配置模块

Hierarchy (view full)

AbstractJsFile
- JsRouteConfigFile

Index

Constructors

Properties

_cleanCode _code _routes ast errorMessage filename importList isAstSynced isError lastModified type workspace

Accessors

cleanCode code routes

Methods

_analysisAst _syncByAst _syncByCode addImportDeclaration addRoute getRouteByRoutePath removeRoute update updateAst updateImportDeclaration updateRoute

Constructors

constructor

new JsRouteConfigFile(workspace, props): JsRouteConfigFile
Parameters
- workspace: AbstractCodeWorkspace
- props: IFileConfig
Returns JsRouteConfigFile
Overrides AbstractJsFile.constructor
- Defined in packages/core/src/models/js-route-config-file.ts:23

Properties

_cleanCode

_cleanCode: string

_code

_code: string

_routes

_routes: IRouteData[]

ast

ast: File

errorMessage

errorMessage: string

文件解析错误消息

`Readonly`filename

filename: string

文件名

importList

importList: ImportDeclarationDataType

导入的依赖列表

isAstSynced

isAstSynced: boolean

ast 是否与 code 保持同步

isError

isError: boolean

文件解析是否出错

lastModified

lastModified: number

最近修改的时间戳

`Readonly`type

文件类型

`Readonly`workspace

workspace: AbstractWorkspace

Accessors

cleanCode

get cleanCode(): string
Returns string
Inherited from AbstractJsFile.cleanCode
- Defined in packages/core/src/models/abstract-file.ts:42

code

get code(): string
Returns string
Inherited from AbstractJsFile.code
- Defined in packages/core/src/models/abstract-file.ts:37

routes

get routes(): IRouteData[]
Returns IRouteData[]
- Defined in packages/core/src/models/js-route-config-file.ts:19

Methods

_analysisAst

_analysisAst(): void
Returns void
Overrides AbstractJsFile._analysisAst
- Defined in packages/core/src/models/js-route-config-file.ts:89

_syncByAst

_syncByAst(): void
基于最新的 ast 进行源码同步

Returns void
Inherited from AbstractJsFile._syncByAst
- Defined in packages/core/src/models/abstract-js-file.ts:103

_syncByCode

_syncByCode(code, isSyncAst?): void
基于输入的源码进行同步
Parameters
- code: string
  源码
- isSyncAst: boolean = true
  是否同步 ast
Returns void
Inherited from AbstractJsFile._syncByCode
- Defined in packages/core/src/models/abstract-js-file.ts:115

addImportDeclaration

addImportDeclaration(source, specifiers): JsRouteConfigFile
Parameters
- source: string
- specifiers: IImportSpecifierData[]
Returns JsRouteConfigFile
Inherited from AbstractJsFile.addImportDeclaration
- Defined in packages/core/src/models/abstract-js-file.ts:90

addRoute

addRoute(routePath, importFilePath): JsRouteConfigFile
添加一条新路由
Parameters
- routePath: string
- importFilePath: string
Returns JsRouteConfigFile
- Defined in packages/core/src/models/js-route-config-file.ts:59

getRouteByRoutePath

getRouteByRoutePath(route): IRouteData
根据路由地址获取 route 对象
Parameters
- route: string
Returns IRouteData
- Defined in packages/core/src/models/js-route-config-file.ts:44

removeRoute

removeRoute(route): JsRouteConfigFile
删除一条路由
Parameters
- route: string
  路由地址
Returns JsRouteConfigFile
- Defined in packages/core/src/models/js-route-config-file.ts:79

update

update(code?, isSyncAst?, isRefreshWorkspace?): void
基于最新的 ast 进行同步
Parameters
- Optionalcode: string
  如果传入 code，则基于 code 进行同步
- isSyncAst: boolean = true
  是否同步 ast
- isRefreshWorkspace: boolean = true
  是否刷新 workspace
Returns void
Inherited from AbstractJsFile.update
- Defined in packages/core/src/models/abstract-js-file.ts:43

updateAst

updateAst(): void
基于当前的代码重新生成 ast

Returns void
Inherited from AbstractJsFile.updateAst
- Defined in packages/core/src/models/abstract-js-file.ts:74

updateImportDeclaration

updateImportDeclaration(source, specifiers): JsRouteConfigFile
Parameters
- source: string
- specifiers: IImportSpecifierData[]
Returns JsRouteConfigFile
Inherited from AbstractJsFile.updateImportDeclaration
- Defined in packages/core/src/models/abstract-js-file.ts:95

updateRoute

updateRoute(oldRoutePath, newRoutePath): JsRouteConfigFile
更新页面路由
Parameters
- oldRoutePath: string
- newRoutePath: string
Returns JsRouteConfigFile
- Defined in packages/core/src/models/js-route-config-file.ts:70