@lcap/asl
Version:
NetEase Application Specific Language
332 lines • 15.7 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RefSchema | @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="../modules/data_schema.html">data/Schema</a>
</li>
<li>
<a href="data_schema.refschema.html">RefSchema</a>
</li>
</ul>
<h1>Interface RefSchema</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>明确一下：有 $ref 时，没有 type；有 type 时，没有 $ref。两者互斥！</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="data_schema.baseschema.html" class="tsd-signature-type" data-tsd-kind="Interface">BaseSchema</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">RefSchema</span>
</li>
</ul>
</li>
</ul>
</section>
<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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_schema.refschema.html#_ref" class="tsd-kind-icon">$ref</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_schema.refschema.html#description" class="tsd-kind-icon">description</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_schema.refschema.html#format" class="tsd-kind-icon">format</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_schema.refschema.html#isarray" class="tsd-kind-icon">is<wbr>Array</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_schema.refschema.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_schema.refschema.html#nullable" class="tsd-kind-icon">nullable</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_schema.refschema.html#required" class="tsd-kind-icon">required</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_schema.refschema.html#type" class="tsd-kind-icon">type</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="_ref" class="tsd-anchor"></a>
<h3>$ref</h3>
<div class="tsd-signature tsd-kind-icon">$ref<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in data/Schema.ts:75</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="description" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="data_schema.baseschema.html">BaseSchema</a>.<a href="data_schema.baseschema.html#description">description</a></p>
<ul>
<li>Defined in data/Schema.ts:7</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="format" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> format</h3>
<div class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="data_schema.baseschema.html">BaseSchema</a>.<a href="data_schema.baseschema.html#format">format</a></p>
<ul>
<li>Defined in data/Schema.ts:5</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="isarray" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Array</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Array<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in data/Schema.ts:79</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>当前这一版先用 isArray 来处理数组类型</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="data_schema.baseschema.html">BaseSchema</a>.<a href="data_schema.baseschema.html#name">name</a></p>
<ul>
<li>Defined in data/Schema.ts:6</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="nullable" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> nullable</h3>
<div class="tsd-signature tsd-kind-icon">nullable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="data_schema.baseschema.html">BaseSchema</a>.<a href="data_schema.baseschema.html#nullable">nullable</a></p>
<ul>
<li>Defined in data/Schema.ts:9</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="required" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> required</h3>
<div class="tsd-signature tsd-kind-icon">required<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="data_schema.baseschema.html">BaseSchema</a>.<a href="data_schema.baseschema.html#required">required</a></p>
<ul>
<li>Defined in data/Schema.ts:8</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="type" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="data_schema.baseschema.html">BaseSchema</a>.<a href="data_schema.baseschema.html#type">type</a></p>
<ul>
<li>Defined in data/Schema.ts:4</li>
</ul>
</aside>
</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="../modules/data_schema.html">data/<wbr>Schema</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-reference tsd-parent-kind-module">
<a href="../modules/data_schema.html#default" class="tsd-kind-icon">default</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.arrayschema.html" class="tsd-kind-icon">Array<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.baseschema.html" class="tsd-kind-icon">Base<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.basicrefschema.html" class="tsd-kind-icon">Basic<wbr>Ref<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.basicschema.html" class="tsd-kind-icon">Basic<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.booleanschema.html" class="tsd-kind-icon">Boolean<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.enumitemschema.html" class="tsd-kind-icon">Enum<wbr>Item<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.enumschema.html" class="tsd-kind-icon">Enum<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.integerschema.html" class="tsd-kind-icon">Integer<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.mapschema.html" class="tsd-kind-icon">Map<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.numberschema.html" class="tsd-kind-icon">Number<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.objectschema.html" class="tsd-kind-icon">Object<wbr>Schema</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.refschema.html" class="tsd-kind-icon">Ref<wbr>Schema</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="data_schema.refschema.html#_ref" class="tsd-kind-icon">$ref</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="data_schema.refschema.html#description" class="tsd-kind-icon">description</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="data_schema.refschema.html#format" class="tsd-kind-icon">format</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="data_schema.refschema.html#isarray" class="tsd-kind-icon">is<wbr>Array</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="data_schema.refschema.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="data_schema.refschema.html#nullable" class="tsd-kind-icon">nullable</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="data_schema.refschema.html#required" class="tsd-kind-icon">required</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="data_schema.refschema.html#type" class="tsd-kind-icon">type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.schema.html" class="tsd-kind-icon">Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.setschema.html" class="tsd-kind-icon">Set<wbr>Schema</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="data_schema.stringschema.html" class="tsd-kind-icon">String<wbr>Schema</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>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>