@lcap/asl

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>data/entityUtils | @lcap/asl</title> <meta name="description" content="Documentation for @lcap/asl"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script async src="../assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">@lcap/asl</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> All <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../modules.html">@lcap/asl</a> </li> <li> <a href="data_entityutils.html">data/entityUtils</a> </li> </ul> <h1>Module data/entityUtils</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Variables</h3> <ul class="tsd-index-list"> <li class="tsd-kind-variable tsd-parent-kind-module"><a href="data_entityutils.html#entity_interface_prefix" class="tsd-kind-icon">ENTITY_INTERFACE_PREFIX</a></li> <li class="tsd-kind-variable tsd-parent-kind-module"><a href="data_entityutils.html#entity_structure_prefix" class="tsd-kind-icon">ENTITY_STRUCTURE_PREFIX</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-module"><a href="data_entityutils.html#getentitygetallqueryparams" class="tsd-kind-icon">getEntityGetAllQueryParams</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="data_entityutils.html#getentityinterfaces" class="tsd-kind-icon">getEntityInterfaces</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="data_entityutils.html#getentitypropertyparams" class="tsd-kind-icon">getEntityPropertyParams</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="data_entityutils.html#getentitystructurenames" class="tsd-kind-icon">getEntityStructureNames</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="data_entityutils.html#getentitystructures" class="tsd-kind-icon">getEntityStructures</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Variables</h2> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"> <a name="entity_interface_prefix" class="tsd-anchor"></a> <h3>Const ENTITY_INTERFACE_PREFIX</h3> <div class="tsd-signature tsd-kind-icon">ENTITY_INTERFACE_PREFIX: string[] = ...</div> <aside class="tsd-sources"> <ul> <li>Defined in data/entityUtils.ts:10</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"> <a name="entity_structure_prefix" class="tsd-anchor"></a> <h3>Const ENTITY_STRUCTURE_PREFIX</h3> <div class="tsd-signature tsd-kind-icon">ENTITY_STRUCTURE_PREFIX: string[] = ...</div> <aside class="tsd-sources"> <ul> <li>Defined in data/entityUtils.ts:9</li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="getentitygetallqueryparams" class="tsd-anchor"></a> <h3>getEntityGetAllQueryParams</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">getEntityGetAllQueryParams(entity: <a href="../classes/data_entity.entity.html" class="tsd-signature-type" data-tsd-kind="Class">Entity</a>): Parameters</li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in data/entityUtils.ts:279</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> 获取实体相关的所有 GET 接口请求参数 </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>entity: <a href="../classes/data_entity.entity.html" class="tsd-signature-type" data-tsd-kind="Class">Entity</a></h5> <div class="tsd-comment tsd-typography"> 实体 </div> </li> </ul> <h4 class="tsd-returns-title">Returns Parameters</h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="getentityinterfaces" class="tsd-anchor"></a> <h3>getEntityInterfaces</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">getEntityInterfaces(entity: <a href="../classes/data_entity.entity.html" class="tsd-signature-type" data-tsd-kind="Class">Entity</a>): ({ 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: {} })[]</li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in data/entityUtils.ts:459</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> 获取实体相关的所有接口 </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>entity: <a href="../classes/data_entity.entity.html" class="tsd-signature-type" data-tsd-kind="Class">Entity</a></h5> <div class="tsd-comment tsd-typography"> 实体 </div> </li> </ul> <h4 class="tsd-returns-title">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: {} })[]</h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="getentitypropertyparams" class="tsd-anchor"></a> <h3>getEntityPropertyParams</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">getEntityPropertyParams(property: <a href="../classes/data_entityproperty.entityproperty.html" class="tsd-signature-type" data-tsd-kind="Class">EntityProperty</a>): Parameters</li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in data/entityUtils.ts:390</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> 获取实体某个属性相关的所有接口参数 </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>property: <a href="../classes/data_entityproperty.entityproperty.html" class="tsd-signature-type" data-tsd-kind="Class">EntityProperty</a></h5> <div class="tsd-comment tsd-typography"> 实体属性 </div> </li> </ul> <h4 class="tsd-returns-title">Returns Parameters</h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="getentitystructurenames" class="tsd-anchor"></a> <h3>Const getEntityStructureNames</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">getEntityStructureNames(entityName: string): string[]</li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in data/entityUtils.ts:63</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> 获取实体相关的所有数据结构的名称 </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>entityName: string</h5> <div class="tsd-comment tsd-typography"> 实体名称 </div> </li> </ul> <h4 class="tsd-returns-title">Returns string[]</h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="getentitystructures" class="tsd-anchor"></a> <h3>getEntityStructures</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">getEntityStructures(entity: <a href="../classes/data_entity.entity.html" class="tsd-signature-type" data-tsd-kind="Class">Entity</a>): ({ 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 })[]</li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in data/entityUtils.ts:70</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> 获取实体相关的所有数据结构 </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>entity: <a href="../classes/data_entity.entity.html" class="tsd-signature-type" data-tsd-kind="Class">Entity</a></h5> <div class="tsd-comment tsd-typography"> 实体 </div> </li> </ul> <h4 class="tsd-returns-title">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 })[]</h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class=" "> <a href="../modules.html">Exports</a> </li> <li class="current tsd-kind-module"> <a href="data_entityutils.html">data/entityUtils</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="data_entityutils.html#entity_interface_prefix" class="tsd-kind-icon">ENTITY_INTERFACE_PREFIX</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="data_entityutils.html#entity_structure_prefix" class="tsd-kind-icon">ENTITY_STRUCTURE_PREFIX</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="data_entityutils.html#getentitygetallqueryparams" class="tsd-kind-icon">getEntityGetAllQueryParams</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="data_entityutils.html#getentityinterfaces" class="tsd-kind-icon">getEntityInterfaces</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="data_entityutils.html#getentitypropertyparams" class="tsd-kind-icon">getEntityPropertyParams</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="data_entityutils.html#getentitystructurenames" class="tsd-kind-icon">getEntityStructureNames</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="data_entityutils.html#getentitystructures" class="tsd-kind-icon">getEntityStructures</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-variable">Variable</li> <li class="tsd-kind-function">Function</li> <li class="tsd-kind-function tsd-has-type-parameter">Function with type parameter</li> <li class="tsd-kind-type-alias">Type alias</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface">Interface</li> <li class="tsd-kind-interface tsd-has-type-parameter">Interface with type parameter</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum">Enumeration</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class">Class</li> </ul> </div> </div> </footer> <div class="container tsd-generator"> Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> </body> </html>