Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Entity

实体类

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional source: Partial<Entity>

      需要合并的部分参数

    Returns Entity

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 dataNode

dataNode: DataNode = ...

父节点

Readonly description

description: string = ...

实体描述

editable

editable: boolean = true

是否可编辑

editing

editing: boolean = false

是否正在编辑 前端 UI 状态

existingNames

existingNames: string[] = ...

周边存在的名称

expanded

expanded: boolean = false

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

Readonly id

id: string = ...

实体 Id

Readonly ideVersion

ideVersion: string = ...

IDE 版本

isLeaf

isLeaf: boolean = false

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

Readonly level

level: LEVEL_ENUM = ...

概念类型

loading

loading: boolean = false

是否正在请求 前端 UI 状态

Readonly name

name: string = ...

实体名称

Readonly propertyList

propertyList: EntityProperty[] = ...

实体属性列表

Readonly resolvers

resolvers: Resolver[] = ...

Readonly schemaRef

schemaRef: string = ...

dataTypes 中的唯一标识

Readonly service

service: MicroService = ...

所属服务

Readonly serviceId

serviceId: string = ...

所属服务 Id

Readonly serviceType

serviceType: string = ...

所属服务类型

Readonly type

type: "object" = 'object'

实体类型（如enum）

Readonly updatedBy

updatedBy: string = ...

修改人

Readonly updatedTime

updatedTime: string = ...

修改时间

Methods

addEntityInterfaces

  • addEntityInterfaces(): Promise<Interface[]>

  • 添加实体相关的接口

    todo

    后面改为后端实现

    Returns Promise<Interface[]>

addEntityStructures

  • addEntityStructures(): Promise<void>

  • 添加实体相关的数据结构

    todo

    后面改为后端实现

    Returns Promise<void>

assign

  • assign(source: any): void

  • Parameters

    • source: any

    Returns void

create

  • 添加实体

    Returns Promise<Entity>

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<Entity>

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

removeEntityInterfaces

  • removeEntityInterfaces(): Promise<void>

  • 删除实体相关的接口

    Returns Promise<void>

removeEntityStructures

  • removeEntityStructures(): Promise<void>

  • 删除实体相关的数据结构

    Returns Promise<void>

setDescription

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

  • 设置实体描述

    Parameters

    • description: string

      描述

    Returns Promise<void>

setName

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

  • 设置实体名称

    Parameters

    • name: string

      名称

    Returns Promise<void>

syncInterfaces

  • syncInterfaces(isDelete?: boolean): Promise<void>

  • 同步interfaces interface、logic、params、returns、variabes采用plainAssign 创建、删除实体，修改实体名称、增删改实体property需要同步

    Parameters

    • Optional isDelete: boolean

    Returns Promise<void>

syncStructures

  • syncStructures(isDelete?: boolean): Promise<Structure[]>

  • 同步structures 创建、删除实体，修改实体名称需要同步

    Parameters

    • Optional isDelete: boolean

    Returns Promise<Structure[]>

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<Entity>

updateEntityInterfaces

  • updateEntityInterfaces(oldEntityName?: string): void

  • 全量更新实体相关接口

    Parameters

    • oldEntityName: string = ...

    Returns void

updateEntityStructuresName

  • updateEntityStructuresName(oldEntityName: string): Promise<void[]>

  • 同步更新实体数据结构名称

    Parameters

    • oldEntityName: string

    Returns Promise<void[]>

Static getVertexByRef

  • getVertexByRef(ref: string): Vertex

  • 通过 Ref 去查找点

    Parameters

    • ref: string

    Returns Vertex

Generated using TypeDoc