@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/dataTypeUtils | @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"> <span class="tsd-select-label">All</span> <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_datatypeutils.html">data/dataTypeUtils</a> </li> </ul> <h1>Module data/dataTypeUtils</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>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-module"><a href="data_datatypeutils.html#convert2reftype" class="tsd-kind-icon">convert2<wbr>Ref<wbr>Type</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="data_datatypeutils.html#convert2schematype" class="tsd-kind-icon">convert2<wbr>Schema<wbr>Type</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="data_datatypeutils.html#genfullrefschemachildren" class="tsd-kind-icon">gen<wbr>Full<wbr>Ref<wbr>Schema<wbr>Children</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="data_datatypeutils.html#geninitdata" class="tsd-kind-icon">gen<wbr>Init<wbr>Data</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="data_datatypeutils.html#genrefschemachildren" class="tsd-kind-icon">gen<wbr>Ref<wbr>Schema<wbr>Children</a></li> <li class="tsd-kind-function tsd-parent-kind-module"><a href="data_datatypeutils.html#genschemachildren" class="tsd-kind-icon">gen<wbr>Schema<wbr>Children</a></li> </ul> </section> </div> </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="convert2reftype" class="tsd-anchor"></a> <h3>convert2<wbr>Ref<wbr>Type</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">convert2<wbr>Ref<wbr>Type<span class="tsd-signature-symbol">(</span>schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in data/dataTypeUtils.ts:33</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>会改变原来的结构，最好自己做深拷贝</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><p>RefType - 用于前端界面的类型描述 { asset: { type: 'object', propertyList: [ { name: 'id', $ref: '#/basicType/Long' }, { name: 'name', $ref: '#/basicType/String' }, ], }, assetType: { type: 'enum', enumItemList: [ { value: 'COMPUTER', label: '台式机' }, { value: 'TABLET', label: '平板电脑' }, { value: 'MOBILE', label: '移动电话' }, }, }， assets: { isArray: true, $ref: '#/xxxx/entity/asset' }, test: { $ref: '#/basicType/Date' } }</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>schema: <a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="convert2schematype" class="tsd-anchor"></a> <h3>convert2<wbr>Schema<wbr>Type</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">convert2<wbr>Schema<wbr>Type<span class="tsd-signature-symbol">(</span>schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>enum<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in data/dataTypeUtils.ts:106</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>会改变原来的结构，最好自己做深拷贝</p> </div> <dl class="tsd-comment-tags"> <dt>example</dt> <dd><p>SchemaType - 非标准的 JSON Schema 结构 { asset: { type: 'object', propertyList: [ { type: 'int', format: 'long' }, { type: 'string' }, ], }, assetType: { type: 'enum', enumItemList: [ { value: 'COMPUTER', label: '台式机' }, { value: 'TABLET', label: '平板电脑' }, { value: 'MOBILE', label: '移动电话' }, }, }， assets: { isArray: true, items: { $ref: '#/xxxx/entity/asset' } }, test: { type: 'string', format: 'date' } }</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>schema: <a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a></h5> </li> <li> <h5>options: <span class="tsd-signature-symbol">{ </span>enum<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> enum<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="genfullrefschemachildren" class="tsd-anchor"></a> <h3>gen<wbr>Full<wbr>Ref<wbr>Schema<wbr>Children</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">gen<wbr>Full<wbr>Ref<wbr>Schema<wbr>Children<span class="tsd-signature-symbol">(</span>schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a>, code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, usedSchemaRefs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in data/dataTypeUtils.ts:239</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>根据 Ref Schema 生成子节点</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>schema: <a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a></h5> </li> <li> <h5>code: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> </div> </li> <li> <h5>usedSchemaRefs: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = ...</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">boolean</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="geninitdata" class="tsd-anchor"></a> <h3>gen<wbr>Init<wbr>Data</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">gen<wbr>Init<wbr>Data<span class="tsd-signature-symbol">(</span>schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a>, relationship<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, usedSchemaRefs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in data/dataTypeUtils.ts:273</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>schema: <a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a></h5> </li> <li> <h5>relationship: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'None'</span></h5> </li> <li> <h5>usedSchemaRefs: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = ...</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">boolean</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="genrefschemachildren" class="tsd-anchor"></a> <h3>gen<wbr>Ref<wbr>Schema<wbr>Children</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">gen<wbr>Ref<wbr>Schema<wbr>Children<span class="tsd-signature-symbol">(</span>schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a>, code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, usedSchemaRefs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in data/dataTypeUtils.ts:189</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>根据 Ref Schema 生成子节点</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>schema: <a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a></h5> </li> <li> <h5>code: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> </div> </li> <li> <h5>usedSchemaRefs: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = ...</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">boolean</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="genschemachildren" class="tsd-anchor"></a> <h3>gen<wbr>Schema<wbr>Children</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">gen<wbr>Schema<wbr>Children<span class="tsd-signature-symbol">(</span>schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a>, code<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, usedSchemaRefs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in data/dataTypeUtils.ts:141</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>根据 Ref Schema 生成子节点</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>schema: <a href="../interfaces/data_schema.schema.html" class="tsd-signature-type" data-tsd-kind="Interface">Schema</a></h5> </li> <li> <h5>code: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ''</span></h5> </li> <li> <h5>usedSchemaRefs: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = ...</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">boolean</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></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_datatypeutils.html">data/data<wbr>Type<wbr>Utils</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="data_datatypeutils.html#convert2reftype" class="tsd-kind-icon">convert2<wbr>Ref<wbr>Type</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="data_datatypeutils.html#convert2schematype" class="tsd-kind-icon">convert2<wbr>Schema<wbr>Type</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="data_datatypeutils.html#genfullrefschemachildren" class="tsd-kind-icon">gen<wbr>Full<wbr>Ref<wbr>Schema<wbr>Children</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="data_datatypeutils.html#geninitdata" class="tsd-kind-icon">gen<wbr>Init<wbr>Data</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="data_datatypeutils.html#genrefschemachildren" class="tsd-kind-icon">gen<wbr>Ref<wbr>Schema<wbr>Children</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="data_datatypeutils.html#genschemachildren" class="tsd-kind-icon">gen<wbr>Schema<wbr>Children</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"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> </body> </html>