-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added api docs for gramseq and textliteral union type for literals
- Loading branch information
1 parent
4c841eb
commit 228fb96
Showing
2 changed files
with
548 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,260 @@ | ||
| <!doctype html> | ||
| <html class="default no-js"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <title>GramSeq | gram.js API</title> | ||
| <meta name="description" content=""> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <link rel="stylesheet" href="../assets/css/main.css"> | ||
| </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> | ||
| <ul class="results-priority" style="display:none"> | ||
| </ul> | ||
| <a href="../index.html" class="title">gram.js API</a> | ||
|  <a href="https://gram-data.github.io/gram-js/guides" class="title">Guides</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> | ||
| <input type="checkbox" id="tsd-filter-only-exported" /> | ||
| <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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/gram_ast.html">gram-ast</a> | ||
| </li> | ||
| <li> | ||
| <a href="gram_ast.gramseq-1.html">GramSeq</a> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div class="container container-main"> | ||
| <div class="row"> | ||
| <div class="col-3 col-menu menu-sticky-wrap menu-highlight"> | ||
| <nav class="tsd-navigation primary"> | ||
| <ul> | ||
| <li class="globals "> | ||
| <a href="../globals.html"><em>Globals</em></a> | ||
| </li> | ||
| <li class="current tsd-kind-module"> | ||
| <a href="../modules/gram_ast.html">gram-ast</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="../modules/gram_builder.html">gram-builder</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="../modules/gram_identity.html">gram-identity</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="../modules/gram_parse.html">gram-parse</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="../modules/gram_stringify.html">gram-stringify</a> | ||
| </li> | ||
| <li class=" tsd-kind-module"> | ||
| <a href="../modules/gram_value.html">gram-value</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| </div> | ||
| <div class="col-7 offset-3 col-content"> | ||
| <h1>Interface GramSeq</h1> | ||
| <section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography tsd-comment-shorttext"> | ||
| <div class="lead"> | ||
| <p>A GramSeq is a graph expressed as a sequence of paths.</p> | ||
| </div> | ||
| </div></section> | ||
| <section class="tsd-panel tsd-hierarchy"> | ||
| <h3>Hierarchy</h3> | ||
| <ul class="tsd-hierarchy"> | ||
| <li> | ||
| <span class="tsd-signature-type">Parent</span> | ||
| <ul class="tsd-hierarchy"> | ||
| <li> | ||
| <span class="target">GramSeq</span> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </section> | ||
| <section class="tsd-panel tsd-kind-interface tsd-parent-kind-module"> | ||
| <h3 class="tsd-before-signature">Indexable</h3> | ||
| <div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">unknown</span></div> | ||
| <div class="tsd-comment tsd-typography tsd-comment-shorttext"> | ||
| <div class="lead"> | ||
| <p>A GramSeq is a graph expressed as a sequence of paths.</p> | ||
| </div> | ||
| </div> | ||
| </section> | ||
| <section class="tsd-panel-group tsd-index-group"> | ||
| <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 tsd-is-overwrite"><a href="gram_ast.gramseq-1.html#children" class="tsd-kind-icon">children</a></li> | ||
| <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="gram_ast.gramseq-1.html#data" class="tsd-kind-icon">data</a></li> | ||
| <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="gram_ast.gramseq-1.html#position" class="tsd-kind-icon">position</a></li> | ||
| <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="gram_ast.gramseq-1.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 tsd-is-overwrite"> | ||
| <a name="children" class="tsd-anchor"></a> | ||
| <h3>children</h3> | ||
| <div class="tsd-signature tsd-kind-icon">children<span class="tsd-signature-symbol">:</span> <a href="gram_ast.grampath-1.html" class="tsd-signature-type">GramPath</a><span class="tsd-signature-symbol">[]</span></div> | ||
| <aside class="tsd-sources"> | ||
| <p>Overrides Parent.children</p> | ||
| <ul> | ||
| <li>Defined in packages/gram-ast/src/gram-types.ts:28</li> | ||
| </ul> | ||
| </aside> | ||
| </section> | ||
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> | ||
| <a name="data" class="tsd-anchor"></a> | ||
| <h3><span class="tsd-flag ts-flagOptional">Optional</span> data</h3> | ||
| <div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Data</span></div> | ||
| <aside class="tsd-sources"> | ||
| <p>Inherited from <a href="gram_ast.gramseq-1.html">GramSeq</a>.<a href="gram_ast.gramseq-1.html#data">data</a></p> | ||
| <ul> | ||
| <li>Defined in packages/gram-ast/node_modules/@types/unist/index.d.ts:23</li> | ||
| </ul> | ||
| </aside> | ||
| <div class="tsd-comment tsd-typography tsd-comment-shorttext"> | ||
| <div class="lead"> | ||
| <p>Information from the ecosystem.</p> | ||
| </div> | ||
| </div> | ||
| </section> | ||
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> | ||
| <a name="position" class="tsd-anchor"></a> | ||
| <h3><span class="tsd-flag ts-flagOptional">Optional</span> position</h3> | ||
| <div class="tsd-signature tsd-kind-icon">position<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Position</span></div> | ||
| <aside class="tsd-sources"> | ||
| <p>Inherited from <a href="gram_ast.gramseq-1.html">GramSeq</a>.<a href="gram_ast.gramseq-1.html#position">position</a></p> | ||
| <ul> | ||
| <li>Defined in packages/gram-ast/node_modules/@types/unist/index.d.ts:29</li> | ||
| </ul> | ||
| </aside> | ||
| <div class="tsd-comment tsd-typography tsd-comment-shorttext"> | ||
| <div class="lead"> | ||
| <p>Location of a node in a source document. | ||
| Must not be present if a node is generated.</p> | ||
| </div> | ||
| </div> | ||
| </section> | ||
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"> | ||
| <a name="type" class="tsd-anchor"></a> | ||
| <h3>type</h3> | ||
| <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"seq"</span></div> | ||
| <aside class="tsd-sources"> | ||
| <p>Overrides <a href="gram_ast.textliteral.html">TextLiteral</a>.<a href="gram_ast.textliteral.html#type">type</a></p> | ||
| <ul> | ||
| <li>Defined in packages/gram-ast/src/gram-types.ts:26</li> | ||
| </ul> | ||
| </aside> | ||
| <div class="tsd-comment tsd-typography tsd-comment-shorttext"> | ||
| <div class="lead"> | ||
| <p>Type discriminator for this AST element, aways 'seq'.</p> | ||
| </div> | ||
| </div> | ||
| </section> | ||
| </section> | ||
| <!--{"options":"/Users/akollegger/Developer/gram-data/gram-js","tsconfig":"/Users/akollegger/Developer/gram-data/gram-js","inputFiles":["./readme.md","./packages/gram-ast/src","./packages/gram-builder/src","./packages/gram-identity/src","./packages/gram-parse/src","./packages/gram-stringify/src","./packages/gram-value/src"],"mode":1,"includeDeclarations":false,"entryPoint":"","exclude":["*.spec.ts"],"externalPattern":[],"excludeExternals":false,"excludeNotExported":false,"excludeNotDocumented":false,"excludePrivate":false,"excludeProtected":false,"ignoreCompilerErrors":true,"disableSources":false,"includes":"","media":"","out":"docs/api","json":"","theme":"node_modules/typedoc-neo-theme/bin/default","name":"gram.js API","includeVersion":false,"excludeTags":[],"readme":"./readme.md","defaultCategory":"Other","categoryOrder":[],"categorizeByGroup":true,"gitRevision":"","gitRemote":"origin","gaID":"","gaSite":"auto","hideGenerator":true,"toc":[],"disableOutputCheck":false,"help":false,"version":false,"plugin":[],"logger":"console","listInvalidSymbolLinks":false,"external-modulemap":".*packages/([^/]+)/src/.*","links":[{"label":"Guides","url":"https://gram-data.github.io/gram-js/guides"}]}--> | ||
| </div> | ||
| <div class="col-2 col-menu secondary-menu"> | ||
| <nav class="tsd-navigation secondary menu-sticky"> | ||
| <ul class="before-current"> | ||
| </ul> | ||
| <ul class="current"> | ||
| <li class="current tsd-kind-module root"> | ||
| <a href="../modules/gram_ast.html" class="tsd-kind-icon">gram-<wbr>ast</a> | ||
| <ul> | ||
| <li class="current tsd-kind-interface tsd-parent-kind-module"> | ||
| <a href="gram_ast.gramseq-1.html" class="tsd-kind-icon">Gram<wbr>Seq</a> | ||
| <ul> | ||
| <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"> | ||
| <a href="gram_ast.gramseq-1.html#children" class="tsd-kind-icon">children</a> | ||
| </li> | ||
| <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> | ||
| <a href="gram_ast.gramseq-1.html#data" class="tsd-kind-icon">data</a> | ||
| </li> | ||
| <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"> | ||
| <a href="gram_ast.gramseq-1.html#position" class="tsd-kind-icon">position</a> | ||
| </li> | ||
| <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"> | ||
| <a href="gram_ast.gramseq-1.html#type" class="tsd-kind-icon">type</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <ul class="after-current"> | ||
| <li class=" tsd-kind-module root"> | ||
| <a href="../modules/gram_builder.html" class="tsd-kind-icon">gram-<wbr>builder</a> | ||
| </li> | ||
| <li class=" tsd-kind-module root"> | ||
| <a href="../modules/gram_identity.html" class="tsd-kind-icon">gram-<wbr>identity</a> | ||
| </li> | ||
| <li class=" tsd-kind-module root"> | ||
| <a href="../modules/gram_parse.html" class="tsd-kind-icon">gram-<wbr>parse</a> | ||
| </li> | ||
| <li class=" tsd-kind-module root"> | ||
| <a href="../modules/gram_stringify.html" class="tsd-kind-icon">gram-<wbr>stringify</a> | ||
| </li> | ||
| <li class=" tsd-kind-module root"> | ||
| <a href="../modules/gram_value.html" class="tsd-kind-icon">gram-<wbr>value</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <footer> | ||
| </footer> | ||
| <div class="overlay"></div> | ||
| <script src="../assets/js/main.js"></script> | ||
| </body> | ||
| </html> |
Oops, something went wrong.