WebService | @lcap/asl

前端服务（模块）类

Hierarchy

Service
- WebService

Index

Constructors

constructor

Properties

Constructors

constructor

new WebService(source?: Partial<WebService>): WebService

Inherited from Service.constructor
- Defined in app/Service.ts:205
Parameters
- Optional source: Partial<WebService>
  
  需要合并的部分参数
Returns WebService

Properties

Protected Readonly JSON_EXCLUDED_KEYS

JSON_EXCLUDED_KEYS: Set<string>

toJSON 时需要去除的键，为了避免出现 CircularJSON

Readonly _cacheTimestamp

_cacheTimestamp: string = ...

前端记录缓存的时间戳

Protected _mutable

_mutable: boolean = true

可修改标志，内部属性标记在构造函数结束后是否可修改

Readonly _uuid

_uuid: string = ...

唯一 uuid 目前主要用于前端 Debug 区分两个实例

Readonly api

api: { builtInFunctions: {}; features: {} } = ...

Type declaration

builtInFunctions: {}
- [name: string]: any
features: {}
- [name: string]: boolean

Readonly app

app: App = ...

所在的 App 父级引用，便于在树状结构中查找

Readonly appId

appId: string = ...

App 的 Id

Readonly config

config: string = ...

其他配置

Readonly createdBy

createdBy: string = ...

创建人

Readonly createdTime

createdTime: string = ...

创建时间

Readonly data

data: DataNode = ...

数据节点

Readonly dnsAddr

dnsAddr: string = ...

editable

editable: boolean = true

是否可编辑

editing

editing: boolean = false

是否正在编辑前端 UI 状态

expanded

expanded: boolean = true

节点是否为展开状态前端 UI 状态

Readonly icon

icon: string = ...

服务图标

Readonly id

id: string = ...

Service Id

Readonly ideVersion

ideVersion: string = ...

IDE 版本

Readonly interfaces

interfaces: Interface[] = ...

接口列表

isLeaf

isLeaf: boolean = false

是否为叶子节点前端 UI 状态

Readonly level

level: LEVEL_ENUM = ...

概念类型

loading

loading: boolean = false

是否正在请求前端 UI 状态

Readonly name

name: string = ...

前端服务标识

Readonly officialType

officialType: "nonofficial" | "official" = ...

是否为官方服务

Readonly packageInfo

packageInfo: { componentDependencies: {}; template: { name: string; version: string }; ui: { name: string; version: string } } = ...

packageJSON 的缩减版

Type declaration

componentDependencies: {}
- [name: string]: string
template: { name: string; version: string }
- name: string
- version: string
ui: { name: string; version: string }
- name: string
- version: string

Readonly pages

pages: Page[] = ...

前端页面

Readonly status

服务状态

Readonly title

title: string = ...

前端服务标题

Readonly type

type: SERVICE_TYPE = ...

服务类型

Readonly updatedBy

updatedBy: string = ...

修改人

Readonly updatedTime

updatedTime: string = ...

修改时间

Methods

Private _onPageTreeChange

_onPageTreeChange(): void

- Defined in app/Service.ts:352
Returns void

addPage

addPage(page: Page): Promise<Page>

- Defined in app/Service.ts:341
Parameters
- page: Page
Returns Promise<Page>

assign

assign(source: any): void

Inherited from Service.assign
- Defined in common/Vertex.ts:116
Parameters
- source: any
Returns void

deepPick

deepPick(source: any, keys?: string[]): void

Inherited from Service.deepPick
- Defined in common/Vertex.ts:183
从对象中深度获取
example
比如一般后端返回只是添加了个 id
```
this.deepPick(result, ['id'])
```
Parameters
- source: any
- keys: string[] = ...
Returns void

emit

emit(eventName: string, ...args: any[]): void

Inherited from Service.emit
- Defined in common/EventEmitter.ts:50
触发事件

Parameters
- eventName: string
  
  事件名
- Rest ...args: any[]
  
  事件参数
Returns void

emitVertexIdToNameChange

emitVertexIdToNameChange(): void

Inherited from Service.emitVertexIdToNameChange
- Defined in common/Vertex.ts:131
Returns void

findUsage

findUsage(): Promise<any>

Inherited from Service.findUsage
- Defined in common/Vertex.ts:242
查找引用

Returns Promise<any>

genAllAssetsInfo

genAllAssetsInfo(prefix: string): { basic: AssetsInfo; custom?: AssetsInfo }

- Defined in app/Service.ts:289
根据 packageInfo 的信息生成用于 load 的 assetsInfo 在环境中需要 basic 和 custom 分开 load，否则容易报错

Parameters
- prefix: string
Returns { basic: AssetsInfo; custom?: AssetsInfo }
- basic: AssetsInfo
- Optional custom?: AssetsInfo

load

load(): Promise<WebService>

- Defined in app/Service.ts:223
Returns Promise<WebService>

loadInterfaces

loadInterfaces(): Promise<Interface[]>

Inherited from Service.loadInterfaces
- Defined in app/Service.ts:129
加载服务所有的接口列表

Returns Promise<Interface[]>

loadPackageInfo

loadPackageInfo(): Promise<void>

- Defined in app/Service.ts:235
Returns Promise<void>

loadPages

loadPages(): Promise<Page[]>

- Defined in app/Service.ts:326
Returns Promise<Page[]>

loadStructures

loadStructures(): Promise<Structure[]>

Inherited from Service.loadStructures
- Defined in app/Service.ts:97
Returns Promise<Structure[]>

off

off(eventName: string, listener: EventListener): void

Inherited from Service.off
- Defined in common/EventEmitter.ts:26
取消监听事件

Parameters
- eventName: string
  
  事件名
- listener: EventListener
  
  监听器
Returns void

on

on(eventName: string, listener: EventListener): void

Inherited from Service.on
- Defined in common/EventEmitter.ts:13
监听事件

Parameters
- eventName: string
  
  事件名
- listener: EventListener
  
  监听器
Returns void

once

once(eventName: string, listener: EventListener): void

Inherited from Service.once
- Defined in common/EventEmitter.ts:38
只监听一次事件

Parameters
- eventName: string
  
  事件名
- listener: EventListener
  
  监听器
Returns void

pick

pick(source: any, keys?: string[]): void

Inherited from Service.pick
- Defined in common/Vertex.ts:162
Parameters
- source: any
- keys: string[] = ...
Returns void

plainAssign

plainAssign(source: any): void

Inherited from Service.plainAssign
- Defined in common/Vertex.ts:143
Parameters
- source: any
Returns void

savePackageInfo

savePackageInfo(): Promise<any>

- Defined in app/Service.ts:268
Returns Promise<any>

toJSON

toJSON(parentKey?: string, excludedKeys?: string[]): any

Inherited from Service.toJSON
- Defined in common/Vertex.ts:209
去除循环依赖，转为纯 JSON

Parameters
- Optional parentKey: string
  
  外面的 key
- excludedKeys: string[] = ...
  
  需要额外排除的 keys
Returns any

toPlainJSON

toPlainJSON(parentKey?: string, excludedKeys?: string[]): any

Inherited from Service.toPlainJSON
- Defined in common/Vertex.ts:225
转为单层的 JSON

Parameters
- Optional parentKey: string
  
  外面的 key
- excludedKeys: string[] = ...
  
  需要额外排除的 keys
Returns any

Static from

from(source: any, app: App): WebService

- Defined in app/Service.ts:361
从后端 JSON 生成规范的 WebService 对象

Parameters
- source: any
  
  JSON
- app: App
  
  父级 App
Returns WebService

Static getVertexByRef

getVertexByRef(ref: string): Vertex

Inherited from Service.getVertexByRef
- Defined in common/Vertex.ts:256
通过 Ref 去查找点

Parameters
- ref: string
Returns Vertex

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional source: Partial<WebService>

Returns WebService

Properties

Protected Readonly JSON_EXCLUDED_KEYS

Readonly _cacheTimestamp

Protected _mutable

Readonly _uuid

Readonly api

Type declaration

builtInFunctions: {}

[name: string]: any

features: {}

[name: string]: boolean

Readonly app

Readonly appId

Readonly config

Readonly createdBy

Readonly createdTime

Readonly data

Readonly dnsAddr

editable

editing

expanded

Readonly icon

Readonly id

Readonly ideVersion

Readonly interfaces

isLeaf

Readonly level

loading

Readonly name

Readonly officialType

Readonly packageInfo

Type declaration

componentDependencies: {}

[name: string]: string

template: { name: string; version: string }

name: string

version: string

ui: { name: string; version: string }

name: string

version: string

Readonly pages

Readonly status

Readonly title

Readonly type

Readonly updatedBy

Readonly updatedTime

Methods

Private _onPageTreeChange

Returns void

addPage

Parameters

page: Page

Returns Promise<Page>

assign

Parameters

source: any

Returns void

deepPick

Parameters

source: any

keys: string[] = ...

Returns void

emit

Parameters

eventName: string

Rest ...args: any[]

Returns void

emitVertexIdToNameChange

Returns void

findUsage