Module | @lcap/nasl

模块

Hierarchy

BaseNode
- Module

Index

Constructors

constructor

Accessors

Constructors

constructor

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

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

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: "Module" = 'Module'

产品概念

dataTreeNodeHidden

dataTreeNodeHidden: boolean = false

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

description

description: string = undefined

模块描述

editable

editable: boolean = undefined

是否正在编辑前端 UI 状态

editing

editing: boolean = false

是否正在编辑前端 UI 状态

entities

entities: Entity[] = []

实体列表

enums

enums: Enum[] = []

枚举列表

expanded

expanded: boolean = false

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

externalDependencyMap

externalDependencyMap: {} = undefined

外部语言依赖

Type declaration

hidden

hidden: boolean = false

节点是否显示前端 UI 状态

id

id: string = ...

唯一 Id

interfaces

interfaces: Interface[] = []

接口列表

isLeaf

isLeaf: boolean = false

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

loading

loading: boolean = false

是否正在请求前端 UI 状态

logicTreeNodeExpanded

logicTreeNodeExpanded: boolean = false

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

logicTreeNodeHidden

logicTreeNodeHidden: boolean = false

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

logics

logics: Logic[] = []

逻辑列表

name

name: string = undefined

模块名称

pageTreeNodeHidden

pageTreeNodeHidden: boolean = false

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

parentNode

parentNode: BaseNode = null

父节点

processes

processes: Process[] = []

流程列表

removable

removable: boolean = undefined

是否可以删除前端 UI 状态

sourceMap

sourceMap: SourceMap = undefined

用于挂 embeddedTS 的 sourceMap

structures

structures: Structure[] = []

数据结构列表

title

title: string = undefined

模块标题

tsErrorDetail

tsErrorDetail: Diagnostic = undefined

当前节点上报错详细信息

type

type: "component" | "interface" | "extension" = undefined

type

version

version: string = undefined

version

viewComponents

viewComponents: ViewComponent[] = []

页面组件列表

views

views: View[] = []

页面列表

Accessors

app

get app(): App

祖先 App

Returns App

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

addEntity

addEntity(entityOptions: Partial<Entity>): Entity
addEntity(entity: Entity): Entity

添加实体

Parameters
- entityOptions: Partial<Entity>
  
  实体参数
Returns Entity
添加实体

Parameters
- entity: Entity
  
  已有的实体实例
Returns Entity

addEnum

addEnum(enumerationOptions: Partial<Enum>): Enum
addEnum(enumeration: Enum): Enum

添加枚举

Parameters
- enumerationOptions: Partial<Enum>
  
  枚举参数
Returns Enum
添加枚举

Parameters
- enumeration: Enum
  
  已有的枚举实例
Returns Enum

addInterface

addInterface(itfaceOptions: Partial<Interface>): Interface
addInterface(itface: Interface): Interface

添加接口

Parameters
- itfaceOptions: Partial<Interface>
  
  接口参数
Returns Interface
添加接口

Parameters
- itface: Interface
  
  已有的接口实例
Returns Interface

addLogic

addLogic(logicOptions: Partial<Logic>): Logic
addLogic(logic: Logic): Logic

添加逻辑

Parameters
- logicOptions: Partial<Logic>
  
  逻辑参数
Returns Logic
添加逻辑

Parameters
- logic: Logic
  
  已有的逻辑实例
Returns Logic

addParamsPrepare

addParamsPrepare(): Promise<any>

Inherited from BaseNode.addParamsPrepare

添加参数准备

Returns Promise<any>

addProcess

addProcess(processOptions: Partial<Process>): Process
addProcess(process: Process): Process

添加流程

Parameters
- processOptions: Partial<Process>
  
  流程参数
Returns Process
添加流程

Parameters
- process: Process
  
  已有的流程实例
Returns Process

addStructure

addStructure(structureOptions: Partial<Structure>): Structure
addStructure(structure: Structure): Structure

添加数据结构

Parameters
- structureOptions: Partial<Structure>
  
  数据结构参数
Returns Structure
添加数据结构

Parameters
- structure: Structure
  
  已有的数据结构实例
Returns Structure

addView

addView(viewOptions: Partial<View>): View
addView(view: View): View

添加页面

Parameters
- viewOptions: Partial<View>
  
  页面参数
Returns View
添加页面

Parameters
- view: View
  
  已有的页面实例
Returns View

addViewComponent

addViewComponent(viewComponentOptions: Partial<ViewComponent>): ViewComponent
addViewComponent(viewComponent: ViewComponent): ViewComponent

添加页面组件

Parameters
- viewComponentOptions: Partial<ViewComponent>
  
  页面组件参数
Returns ViewComponent
添加页面组件

Parameters
- viewComponent: ViewComponent
  
  已有的页面组件实例
Returns ViewComponent

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

findProperty

findProperty(name: string, propertyType: PropertyType): any

获取属性节点是否存在

Parameters
- name: string
- propertyType: PropertyType
Returns any

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

getNamespace

getNamespace(): string

获取命名空间暂时不考虑 Module 嵌套的情况

Returns string

insertEntityAt

insertEntityAt(name: string, index: number): Entity
insertEntityAt(entityOptions: Partial<Entity>, index: number): Entity
insertEntityAt(entity: Entity, index: number): Entity

插入实体

Parameters
- name: string
  
  实体名称，如果不填会自动生成一个唯一名称
- index: number
Returns Entity
插入实体

Parameters
- entityOptions: Partial<Entity>
  
  实体参数
- index: number
Returns Entity
插入实体

Parameters
- entity: Entity
  
  已有的实体实例
- index: number
Returns Entity

insertEnumAt

insertEnumAt(name: string, index: number): Enum
insertEnumAt(enumerationOptions: Partial<Enum>, index: number): Enum
insertEnumAt(enumeration: Enum, index: number): Enum

插入枚举

Parameters
- name: string
  
  枚举名称，如果不填会自动生成一个唯一名称
- index: number
Returns Enum
插入枚举

Parameters
- enumerationOptions: Partial<Enum>
  
  枚举参数
- index: number
Returns Enum
插入枚举

Parameters
- enumeration: Enum
  
  已有的枚举实例
- index: number
Returns Enum

insertInterfaceAt

insertInterfaceAt(name: string, index: number): Interface
insertInterfaceAt(itfaceOptions: Partial<Interface>, index: number): Interface
insertInterfaceAt(itface: Interface, index: number): Interface

插入接口

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

Parameters
- itfaceOptions: Partial<Interface>
  
  接口参数
- index: number
Returns Interface
插入接口

Parameters
- itface: Interface
  
  已有的接口实例
- index: number
Returns Interface

insertLogicAt

insertLogicAt(name: string, index: number): Logic
insertLogicAt(logicOptions: Partial<Logic>, index: number): Logic
insertLogicAt(logic: Logic, index: number): Logic

插入逻辑

Parameters
- name: string
  
  逻辑名称，如果不填会自动生成一个唯一名称
- index: number
Returns Logic
插入逻辑

Parameters
- logicOptions: Partial<Logic>
  
  逻辑参数
- index: number
Returns Logic
插入逻辑

Parameters
- logic: Logic
  
  已有的逻辑实例
- index: number
Returns Logic

insertProcessAt

insertProcessAt(name: string, index: number): Process
insertProcessAt(processOptions: Partial<Process>, index: number): Process
insertProcessAt(process: Process, index: number): Process

插入流程

Parameters
- name: string
  
  流程名称，如果不填会自动生成一个唯一名称
- index: number
Returns Process
插入流程

Parameters
- processOptions: Partial<Process>
  
  流程参数
- index: number
Returns Process
插入流程

Parameters
- process: Process
  
  已有的流程实例
- index: number
Returns Process

insertStructureAt

insertStructureAt(name: string, index: number): Structure
insertStructureAt(structureOptions: Partial<Structure>, index: number): Structure
insertStructureAt(structure: Structure, index: number): Structure

插入数据结构

Parameters
- name: string
  
  数据结构名称，如果不填会自动生成一个唯一名称
- index: number
Returns Structure
插入数据结构

Parameters
- structureOptions: Partial<Structure>
  
  数据结构参数
- index: number
Returns Structure
插入数据结构

Parameters
- structure: Structure
  
  已有的数据结构实例
- index: number
Returns Structure

insertViewAt

insertViewAt(name: string, index: number): View
insertViewAt(viewOptions: Partial<View>, index: number): View
insertViewAt(view: View, index: number): View

插入页面

Parameters
- name: string
  
  页面名称，如果不填会自动生成一个唯一名称
- index: number
Returns View
插入页面

Parameters
- viewOptions: Partial<View>
  
  页面参数
- index: number
Returns View
插入页面

Parameters
- view: View
  
  已有的页面实例
- index: number
Returns View

insertViewComponentAt

insertViewComponentAt(name: string, index: number): ViewComponent
insertViewComponentAt(viewComponentOptions: Partial<ViewComponent>, index: number): ViewComponent
insertViewComponentAt(viewComponent: ViewComponent, index: number): ViewComponent

插入页面组件

Parameters
- name: string
  
  页面组件名称，如果不填会自动生成一个唯一名称
- index: number
Returns ViewComponent
插入页面组件

Parameters
- viewComponentOptions: Partial<ViewComponent>
  
  页面组件参数
- index: number
Returns ViewComponent
插入页面组件

Parameters
- viewComponent: ViewComponent
  
  已有的页面组件实例
- index: number
Returns ViewComponent

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>

removeEntity

removeEntity(name: string): void
removeEntity(entity: Entity): void

删除实体

Parameters
- name: string
  
  实体名称
Returns void
删除实体

Parameters
- entity: Entity
  
  已有的实体实例
Returns void

removeEnum

removeEnum(name: string): void
removeEnum(enumeration: Enum): void

删除枚举

Parameters
- name: string
  
  枚举名称
Returns void
删除枚举

Parameters
- enumeration: Enum
  
  已有的枚举实例
Returns void

removeInterface

removeInterface(name: string): void
removeInterface(itface: Interface): void

删除接口

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

Parameters
- itface: Interface
  
  已有的接口实例
Returns void

removeLogic

removeLogic(name: string): void
removeLogic(logic: Logic): void

删除逻辑

Parameters
- name: string
  
  逻辑名称
Returns void
删除逻辑

Parameters
- logic: Logic
  
  已有的逻辑实例
Returns void

removeProcess

removeProcess(name: string): void
removeProcess(process: Process): void

删除流程

Parameters
- name: string
  
  流程名称
Returns void
删除流程

Parameters
- process: Process
  
  已有的流程实例
Returns void

removeStructure

removeStructure(name: string): void
removeStructure(structure: Structure): void

删除数据结构

Parameters
- name: string
  
  数据结构名称
Returns void
删除数据结构

Parameters
- structure: Structure
  
  已有的数据结构实例
Returns void

removeView

removeView(name: string): void
removeView(view: View): void

删除页面

Parameters
- name: string
  
  页面名称
Returns void
删除页面

Parameters
- view: View
  
  已有的页面实例
Returns void

removeViewComponent

removeViewComponent(name: string): void
removeViewComponent(viewComponent: ViewComponent): void

删除页面组件

Parameters
- name: string
  
  页面组件名称
Returns void
删除页面组件

Parameters
- viewComponent: ViewComponent
  
  已有的页面组件实例
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<Module>

Returns Module

Properties

Readonly JSON_EXCLUDED_KEYS

_mutable

branchName

changedTime

concept

dataTreeNodeHidden

description

editable

editing

entities

enums

expanded

externalDependencyMap

Type declaration

hidden

id

interfaces

isLeaf

loading

logicTreeNodeExpanded

logicTreeNodeHidden

logics

name

pageTreeNodeHidden

parentNode

processes

removable

sourceMap

structures

title

tsErrorDetail

type

version

viewComponents

views

Accessors

app

Returns App

rootNode

Returns BaseNode

upperNode

Returns BaseNode

Methods

activeInside

Parameters

source: any

Ctor: any

parentNode: any

parentKey: string

Returns any

addEntity

Parameters

entityOptions: Partial<Entity>

Returns Entity

Parameters

entity: Entity

Returns Entity

addEnum

Parameters

enumerationOptions: Partial<Enum>

Returns Enum

Parameters

enumeration: Enum

Returns Enum

addInterface

Parameters

itfaceOptions: Partial<Interface>

Returns Interface