Interface | @lcap/nasl

接口

Hierarchy

BaseNode
- Interface

Constructors

constructor

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

Overrides BaseNode.constructor
Parameters
- Optional source: Partial<Interface>
  
  需要合并的部分参数
Returns Interface

Properties

Readonly JSON_EXCLUDED_KEYS

JSON_EXCLUDED_KEYS: Set<string>

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

_mutable

_mutable: boolean = true

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

branchName

branchName: string = undefined

分支名称

changedTime

changedTime: number = undefined

变动时间

concept

concept: "Interface" = 'Interface'

产品概念

dataTreeNodeHidden

dataTreeNodeHidden: boolean = false

数据树节点是否显示前端 UI 状态

description

description: string = undefined

接口描述

editable

editable: boolean = undefined

是否正在编辑前端 UI 状态

editing

editing: boolean = false

是否正在编辑前端 UI 状态

expanded

expanded: boolean = false

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

hidden

hidden: boolean = false

节点是否显示前端 UI 状态

id

id: string = ...

唯一 Id

isLeaf

isLeaf: boolean = false

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

loading

loading: boolean = false

是否正在请求前端 UI 状态

logicTreeNodeExpanded

logicTreeNodeExpanded: boolean = false

数据树节点是否展开前端 UI 状态

logicTreeNodeHidden

logicTreeNodeHidden: boolean = false

逻辑树节点是否显示前端 UI 状态

method

method: "POST" | "GET" | "DELETE" | "PUT" = undefined

method

name

name: string = undefined

接口名称

originLogicName

originLogicName: string = undefined

originLogicName

pageTreeNodeHidden

pageTreeNodeHidden: boolean = false

页面树节点是否显示前端 UI 状态

params

params: InterfaceParam[] = []

接口参数列表

parentNode

parentNode: BaseNode = null

父节点

path

path: string = undefined

path

removable

removable: boolean = undefined

是否可以删除前端 UI 状态

returns

returns: Return[] = []

输出参数列表

sourceMap

sourceMap: SourceMap = undefined

用于挂 embeddedTS 的 sourceMap

tsErrorDetail

tsErrorDetail: Diagnostic = undefined

当前节点上报错详细信息

Accessors

app

get app(): App

祖先 App

Returns App

module

get module(): Module

祖先 Module

Returns Module

nodeReadonly

get nodeReadonly(): boolean

是否可编辑

Returns boolean

rootNode

get rootNode(): BaseNode

Inherited from BaseNode.rootNode

根节点

Returns BaseNode

upperNode

get upperNode(): BaseNode

Inherited from BaseNode.upperNode

上层节点

Returns BaseNode

Methods

activeInside

activeInside(source: any, Ctor: any, parentNode: any, parentKey: string): any

Inherited from BaseNode.activeInside

激活 JSON 内部实例

Parameters
- source: any
- Ctor: any
- parentNode: any
- parentKey: string
Returns any

addInterfaceParam

addInterfaceParam(interfaceParamOptions: Partial<InterfaceParam>): InterfaceParam
addInterfaceParam(interfaceParam: InterfaceParam): InterfaceParam

添加接口参数

Parameters
- interfaceParamOptions: Partial<InterfaceParam>
  
  接口参数参数
Returns InterfaceParam
添加接口参数

Parameters
- interfaceParam: InterfaceParam
  
  已有的接口参数实例
Returns InterfaceParam

addParamsPrepare

addParamsPrepare(): Promise<any>

Inherited from BaseNode.addParamsPrepare

添加参数准备

Returns Promise<any>

addReturn

addReturn(retOptions: Partial<Return>): Return
addReturn(ret: Return): Return

添加输出参数

Parameters
- retOptions: Partial<Return>
  
  输出参数参数
Returns Return
添加输出参数

Parameters
- ret: Return
  
  已有的输出参数实例
Returns Return

changeName

changeName(newValue: string): Promise<any>

Inherited from BaseNode.changeName

重命名

Parameters
- newValue: string
Returns Promise<any>

create

create(parentParams: Params): void

Inherited from BaseNode.create

创建节点

Parameters
- parentParams: Params
Returns void

deepPick

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

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

delete

delete(): void

Inherited from BaseNode.delete

删除节点

Returns void

destroy

destroy(): void

Inherited from BaseNode.destroy

销毁从 Map 中删除点和子节点

Returns void

emit

emit(eventName: string, event?: EventPayload, target?: any): void

Inherited from BaseNode.emit

触发事件

Parameters
- eventName: string
  
  事件名
- Optional event: EventPayload
- Optional target: any
Returns void

findUsage

findUsage(): Promise<any>

Inherited from BaseNode.findUsage

查找引用

Returns Promise<any>

genActionListener

genActionListener(action: string): (($event: EventPayload) => void)

Inherited from BaseNode.genActionListener

为存储点生成行为监听器

Parameters
- action: string
Returns (($event: EventPayload) => void)
- - ($event: EventPayload): void
  - Parameters
    - $event: EventPayload
    Returns void

genSources

genSources(instance: BaseNode, filerFn?: ((source: Partial<BaseNode>) => {})): {}

Inherited from BaseNode.genSources

生成json

Parameters
- instance: BaseNode
- Optional filerFn: ((source: Partial<BaseNode>) => {})
  - - (source: Partial<BaseNode>): {}
    - Parameters
      - source: Partial<BaseNode>
      Returns {}
Returns {}

getAncestor

getAncestor(concept: string): BaseNode

Inherited from BaseNode.getAncestor

获取祖先节点

Parameters
- concept: string
Returns BaseNode

getEmbeddedFilePath

getEmbeddedFilePath(name?: string): string

生成宿主语言的文件路径

Parameters
- name: string = ...
  
  一般不用传，用于 rename
Returns string

insertInterfaceParamAt

insertInterfaceParamAt(name: string, index: number): InterfaceParam
insertInterfaceParamAt(interfaceParamOptions: Partial<InterfaceParam>, index: number): InterfaceParam
insertInterfaceParamAt(interfaceParam: InterfaceParam, index: number): InterfaceParam

插入接口参数

Parameters
- name: string
  
  接口参数名称，如果不填会自动生成一个唯一名称
- index: number
Returns InterfaceParam
插入接口参数

Parameters
- interfaceParamOptions: Partial<InterfaceParam>
  
  接口参数参数
- index: number
Returns InterfaceParam
插入接口参数

Parameters
- interfaceParam: InterfaceParam
  
  已有的接口参数实例
- index: number
Returns InterfaceParam

insertReturnAt

insertReturnAt(name: string, index: number): Return
insertReturnAt(retOptions: Partial<Return>, index: number): Return
insertReturnAt(ret: Return, index: number): Return

插入输出参数

Parameters
- name: string
  
  输出参数名称，如果不填会自动生成一个唯一名称
- index: number
Returns Return
插入输出参数

Parameters
- retOptions: Partial<Return>
  
  输出参数参数
- index: number
Returns Return
插入输出参数

Parameters
- ret: Return
  
  已有的输出参数实例
- index: number
Returns Return

instantiate

instantiate(source: any, parentNode: BaseNode, parentKey: string): any

Inherited from BaseNode.instantiate

实例化一个 JSON 由于有 from，只能先实例化父级，再实例化子级

Parameters
- source: any
- parentNode: BaseNode
- parentKey: string
Returns any

off

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

Inherited from BaseNode.off

取消监听事件

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

on

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

Inherited from BaseNode.on

监听事件

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

once

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

Inherited from BaseNode.once

只监听一次事件

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

prepareDelete

prepareDelete(): Promise<any>

Inherited from BaseNode.prepareDelete

准备删除

Returns Promise<any>

removeInterfaceParam

removeInterfaceParam(name: string): void
removeInterfaceParam(interfaceParam: InterfaceParam): void

删除接口参数

Parameters
- name: string
  
  接口参数名称
Returns void
删除接口参数

Parameters
- interfaceParam: InterfaceParam
  
  已有的接口参数实例
Returns void

removeReturn

removeReturn(name: string): void
removeReturn(ret: Return): void

删除输出参数

Parameters
- name: string
  
  输出参数名称
Returns void
删除输出参数

Parameters
- ret: Return
  
  已有的输出参数实例
Returns void

setDescription

setDescription(description: string): void

设置接口描述

Parameters
- description: string
Returns void

setName

setName(name: string): void

设置接口名称

Parameters
- name: string
Returns void

toJSON

toJSON(): {}

Inherited from BaseNode.toJSON

去除循环依赖，转为纯 JSON

Returns {}

toPlainJSON

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

Inherited from BaseNode.toPlainJSON

转为单层的 JSON

Parameters
- Optional parentKey: string
  
  外面的 key，提供给 JSON.stringify 使用
- excludedKeys: string[] = []
  
  需要额外排除的 keys
Returns any

update

update(__namedParameters: any): void

Inherited from BaseNode.update

更新节点

Parameters
- __namedParameters: any
Returns void

Static getDefaultOptions

getDefaultOptions(): any

Inherited from BaseNode.getDefaultOptions

获取添加时的默认选项

Returns any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional source: Partial<Interface>

Returns Interface

Properties

Readonly JSON_EXCLUDED_KEYS

_mutable

branchName

changedTime

concept

dataTreeNodeHidden

description

editable

editing

expanded

hidden

id

isLeaf

loading

logicTreeNodeExpanded

logicTreeNodeHidden

method

name

originLogicName

pageTreeNodeHidden

params

parentNode

path

removable

returns

sourceMap

tsErrorDetail

Accessors

app

Returns App

module

Returns Module

nodeReadonly

Returns boolean

rootNode

Returns BaseNode

upperNode

Returns BaseNode

Methods

activeInside

Parameters

source: any

Ctor: any

parentNode: any

parentKey: string

Returns any

addInterfaceParam

Parameters

interfaceParamOptions: Partial<InterfaceParam>

Returns InterfaceParam

Parameters

interfaceParam: InterfaceParam

Returns InterfaceParam

addParamsPrepare

Returns Promise<any>

addReturn

Parameters

retOptions: Partial<Return>

Returns Return

Parameters

ret: Return

Returns Return

changeName

Parameters

newValue: string

Returns Promise<any>

create

Parameters