Options
All
  • Public
  • Public/Protected
  • All
Menu

Module data/entityUtils

Index

Variables

Functions

Variables

Const ENTITY_INTERFACE_PREFIX

ENTITY_INTERFACE_PREFIX: string[] = ...

Const ENTITY_STRUCTURE_PREFIX

ENTITY_STRUCTURE_PREFIX: string[] = ...

Functions

getEntityGetAllQueryParams

  • getEntityGetAllQueryParams(entity: Entity): Parameters

  • 获取实体相关的所有 GET 接口请求参数

    Parameters

    Returns Parameters

getEntityInterfaces

  • getEntityInterfaces(entity: Entity): ({ data: { description: string; method: string; name: string; parameters: string; path: string; requestBody: undefined; responses: string }; resolver: { ast: { object: { object: { name: string; type: string }; property: { name: string; type: string }; type: string }; property: { name: string; type: string }; type: string }; code: string } } | { data: { description: string; method: string; name: string; parameters: string; path: string; requestBody: undefined; responses: string }; resolver: { ast: { object: { name: string; type: string }; property: { name: string; type: string }; type: string }; code: string } } | { data: { description: string; method: string; name: string; parameters: string; path: string; requestBody: string; responses: string }; resolver: {} } | { data: { description: string; method: string; name: string; parameters: string; path: string; requestBody: undefined; responses: string }; resolver: {} })[]

  • 获取实体相关的所有接口

    Parameters

    Returns ({ data: { description: string; method: string; name: string; parameters: string; path: string; requestBody: undefined; responses: string }; resolver: { ast: { object: { object: { name: string; type: string }; property: { name: string; type: string }; type: string }; property: { name: string; type: string }; type: string }; code: string } } | { data: { description: string; method: string; name: string; parameters: string; path: string; requestBody: undefined; responses: string }; resolver: { ast: { object: { name: string; type: string }; property: { name: string; type: string }; type: string }; code: string } } | { data: { description: string; method: string; name: string; parameters: string; path: string; requestBody: string; responses: string }; resolver: {} } | { data: { description: string; method: string; name: string; parameters: string; path: string; requestBody: undefined; responses: string }; resolver: {} })[]

getEntityPropertyParams

  • 获取实体某个属性相关的所有接口参数

    Parameters

    Returns Parameters

Const getEntityStructureNames

  • getEntityStructureNames(entityName: string): string[]

  • 获取实体相关的所有数据结构的名称

    Parameters

    • entityName: string

      实体名称

    Returns string[]

getEntityStructures

  • getEntityStructures(entity: Entity): ({ name: string; propertyList: ({ $ref: string; description: string; isArray: boolean; level: string; name: string } | { $ref: string; description: string; isArray: undefined; level: string; name: string })[]; structureRef: undefined; type: string } | { name: string; propertyList: ({ $ref: string; description: string; format: undefined; level: string; name: string; type: undefined } | { $ref: string; description: string; format: string; level: string; name: string; type: string })[]; structureRef: string; type: string } | { name: string; propertyList: { $ref: string; level: string; name: string }[]; structureRef: undefined; type: string })[]

  • 获取实体相关的所有数据结构

    Parameters

    Returns ({ name: string; propertyList: ({ $ref: string; description: string; isArray: boolean; level: string; name: string } | { $ref: string; description: string; isArray: undefined; level: string; name: string })[]; structureRef: undefined; type: string } | { name: string; propertyList: ({ $ref: string; description: string; format: undefined; level: string; name: string; type: undefined } | { $ref: string; description: string; format: string; level: string; name: string; type: string })[]; structureRef: string; type: string } | { name: string; propertyList: { $ref: string; level: string; name: string }[]; structureRef: undefined; type: string })[]

Generated using TypeDoc