Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Interface

接口类

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

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 createdBy

createdBy: string = ...

创建人

Readonly createdTime

createdTime: string = ...

创建时间

Readonly description

description: string = ...

描述

editable

editable: boolean = true

是否可编辑

editing

editing: boolean = false

是否正在编辑 前端 UI 状态

Readonly entityId

entityId: string = ...

所属实体 Id

existingNames

existingNames: string[] = ...

周边存在的名称

expanded

expanded: boolean = false

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

Readonly host

host: string = ...

地址

Readonly id

id: string = ...

Id

Readonly ideVersion

ideVersion: string = ...

IDE 版本

isLeaf

isLeaf: boolean = false

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

Readonly key

key: string = ...

InterfaceKey

Readonly level

level: LEVEL_ENUM = ...

概念类型

loading

loading: boolean = false

是否正在请求 前端 UI 状态

Readonly logic

logic: Logic = ...

逻辑

todo

使用 excludedInJSON 有点问题，不同 class 相同字段会串

Readonly logicId

logicId: string = ...

逻辑 Id

Readonly method

method: string = ...

方法

Readonly moreChildrenFields

moreChildrenFields: string[] = ...

树组件的子节点字段

Readonly name

name: string = ...

名称

Readonly parameters

parameters: string = ...

参数

Readonly path

path: string = ...

路径

Readonly port

port: string = ...

端口

Readonly protocol

protocol: string = ...

协议

Readonly requestBody

requestBody: string = ...

请求数据

Readonly responses

responses: string = ...

返回值

Readonly service

service: MicroService = ...

Service

Readonly serviceId

serviceId: string = ...

Service Id

Readonly serviceName

serviceName: string = ...

Service 名称

Readonly serviceType

serviceType: "micro" | "entity" = ...

Service 类型

Readonly updatedBy

updatedBy: string = ...

修改人

Readonly updatedTime

updatedTime: string = ...

修改时间

Methods

assign

  • assign(source: any): void

  • Parameters

    • source: any

    Returns void

create

  • 添加接口

    Returns Promise<Interface>

deepPick

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

  • 从对象中深度获取

    example

    比如一般后端返回只是添加了个 id

    this.deepPick(result, ['id'])

    Parameters

    • source: any
    • keys: string[] = ...

    Returns void

delete

  • delete(): Promise<void>

  • 删除接口

    Returns Promise<void>

emit

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

  • 触发事件

    Parameters

    • eventName: string

      事件名

    • Rest ...args: any[]

      事件参数

    Returns void

emitVertexIdToNameChange

  • emitVertexIdToNameChange(): void

findUsage

  • findUsage(): Promise<any>

  • 查找引用

    Returns Promise<any>

load

  • 按当前 id 加载接口数据

    requires

    this.id

    Returns Promise<Interface>

off

  • 取消监听事件

    Parameters

    Returns void

on

  • 监听事件

    Parameters

    Returns void

once

  • 只监听一次事件

    Parameters

    Returns void

pick

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

  • Parameters

    • source: any
    • keys: string[] = ...

    Returns void

plainAssign

  • plainAssign(source: any): void

  • Parameters

    • source: any

    Returns void

setDescription

  • setDescription(description: string): Promise<void>

  • 设置接口描述

    Parameters

    • description: string

    Returns Promise<void>

setMethod

  • setMethod(method: string): Promise<void>

  • 设置接口方法

    Parameters

    • method: string

    Returns Promise<void>

setName

  • setName(name: string): Promise<void>

  • 设置接口名称

    Parameters

    • name: string

    Returns Promise<void>

setPath

  • setPath(path: string): Promise<void>

  • 设置接口路径

    Parameters

    • path: string

    Returns Promise<void>

toJSON

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

  • 去除循环依赖，转为纯 JSON

    Parameters

    • Optional parentKey: string

      外面的 key

    • excludedKeys: string[] = ...

      需要额外排除的 keys

    Returns any

toPlainJSON

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

  • 转为单层的 JSON

    Parameters

    • Optional parentKey: string

      外面的 key

    • excludedKeys: string[] = ...

      需要额外排除的 keys

    Returns any

update

  • 更新实体

    Returns Promise<Interface>

Static from

  • 从后端 JSON 生成规范的 Interface 对象

    Parameters

    Returns Interface

Static getVertexByRef

  • getVertexByRef(ref: string): Vertex

  • 通过 Ref 去查找点

    Parameters

    • ref: string

    Returns Vertex

Generated using TypeDoc