Skip to content

Commit f849b0c

Browse files
committed
docs update
1 parent 8fe25af commit f849b0c

File tree

100 files changed

+11241
-4496
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+11241
-4496
lines changed

docs/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/facetmetadata.html renamed to docs/classes/_src_metadata_facet_.facetmetadata.html

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>FacetMetadata | dgraph-orm</title>
6+
<title>FacetMetadata | @xanthous/dgraph-orm</title>
77
<meta name="description" content="">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
@@ -22,7 +22,7 @@
2222
<li class="state loading">Preparing search index...</li>
2323
<li class="state failure">The search index is not available</li>
2424
</ul>
25-
<a href="../index.html" class="title">dgraph-orm</a>
25+
<a href="../index.html" class="title">@xanthous/dgraph-orm</a>
2626
</div>
2727
<div class="table-cell" id="tsd-widgets">
2828
<div id="tsd-filter">
@@ -38,6 +38,8 @@
3838
</div>
3939
<input type="checkbox" id="tsd-filter-inherited" checked />
4040
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41+
<input type="checkbox" id="tsd-filter-externals" checked />
42+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
4143
<input type="checkbox" id="tsd-filter-only-exported" />
4244
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
4345
</div>
@@ -54,7 +56,10 @@
5456
<a href="../globals.html">Globals</a>
5557
</li>
5658
<li>
57-
<a href="facetmetadata.html">FacetMetadata</a>
59+
<a href="../modules/_src_metadata_facet_.html">&quot;src/metadata/facet&quot;</a>
60+
</li>
61+
<li>
62+
<a href="_src_metadata_facet_.facetmetadata.html">FacetMetadata</a>
5863
</li>
5964
</ul>
6065
<h1>Class FacetMetadata</h1>
@@ -79,19 +84,19 @@ <h2>Index</h2>
7984
<section class="tsd-index-section ">
8085
<h3>Interfaces</h3>
8186
<ul class="tsd-index-list">
82-
<li class="tsd-kind-interface tsd-parent-kind-class"><a href="../interfaces/facetmetadata.iargs.html" class="tsd-kind-icon">IArgs</a></li>
87+
<li class="tsd-kind-interface tsd-parent-kind-class"><a href="../interfaces/_src_metadata_facet_.facetmetadata.iargs.html" class="tsd-kind-icon">IArgs</a></li>
8388
</ul>
8489
</section>
8590
<section class="tsd-index-section ">
8691
<h3>Constructors</h3>
8792
<ul class="tsd-index-list">
88-
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="facetmetadata.html#constructor" class="tsd-kind-icon">constructor</a></li>
93+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_src_metadata_facet_.facetmetadata.html#constructor" class="tsd-kind-icon">constructor</a></li>
8994
</ul>
9095
</section>
9196
<section class="tsd-index-section ">
9297
<h3>Properties</h3>
9398
<ul class="tsd-index-list">
94-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="facetmetadata.html#args" class="tsd-kind-icon">args</a></li>
99+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_metadata_facet_.facetmetadata.html#args" class="tsd-kind-icon">args</a></li>
95100
</ul>
96101
</section>
97102
</div>
@@ -103,22 +108,22 @@ <h2>Constructors</h2>
103108
<a name="constructor" class="tsd-anchor"></a>
104109
<h3>constructor</h3>
105110
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
106-
<li class="tsd-signature tsd-kind-icon">new <wbr>Facet<wbr>Metadata<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><a href="../interfaces/facetmetadata.iargs.html" class="tsd-signature-type">IArgs</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="facetmetadata.html" class="tsd-signature-type">FacetMetadata</a></li>
111+
<li class="tsd-signature tsd-kind-icon">new <wbr>Facet<wbr>Metadata<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><a href="../interfaces/_src_metadata_facet_.facetmetadata.iargs.html" class="tsd-signature-type">IArgs</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_metadata_facet_.facetmetadata.html" class="tsd-signature-type">FacetMetadata</a></li>
107112
</ul>
108113
<ul class="tsd-descriptions">
109114
<li class="tsd-description">
110115
<aside class="tsd-sources">
111116
<ul>
112-
<li>Defined in <a href="https://github.com/osmanmesutozcan/dgraph-orm/blob/1f5658d/src/metadata/facet.ts#L1">src/metadata/facet.ts:1</a></li>
117+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/8fe25af/src/metadata/facet.ts#L1">src/metadata/facet.ts:1</a></li>
113118
</ul>
114119
</aside>
115120
<h4 class="tsd-parameters-title">Parameters</h4>
116121
<ul class="tsd-parameters">
117122
<li>
118-
<h5>args: <a href="../interfaces/facetmetadata.iargs.html" class="tsd-signature-type">IArgs</a></h5>
123+
<h5>args: <a href="../interfaces/_src_metadata_facet_.facetmetadata.iargs.html" class="tsd-signature-type">IArgs</a></h5>
119124
</li>
120125
</ul>
121-
<h4 class="tsd-returns-title">Returns <a href="facetmetadata.html" class="tsd-signature-type">FacetMetadata</a></h4>
126+
<h4 class="tsd-returns-title">Returns <a href="_src_metadata_facet_.facetmetadata.html" class="tsd-signature-type">FacetMetadata</a></h4>
122127
</li>
123128
</ul>
124129
</section>
@@ -128,10 +133,10 @@ <h2>Properties</h2>
128133
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
129134
<a name="args" class="tsd-anchor"></a>
130135
<h3>args</h3>
131-
<div class="tsd-signature tsd-kind-icon">args<span class="tsd-signature-symbol">:</span> <a href="../interfaces/facetmetadata.iargs.html" class="tsd-signature-type">IArgs</a></div>
136+
<div class="tsd-signature tsd-kind-icon">args<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_src_metadata_facet_.facetmetadata.iargs.html" class="tsd-signature-type">IArgs</a></div>
132137
<aside class="tsd-sources">
133138
<ul>
134-
<li>Defined in <a href="https://github.com/osmanmesutozcan/dgraph-orm/blob/1f5658d/src/metadata/facet.ts#L2">src/metadata/facet.ts:2</a></li>
139+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/8fe25af/src/metadata/facet.ts#L2">src/metadata/facet.ts:2</a></li>
135140
</ul>
136141
</aside>
137142
</section>
@@ -143,23 +148,26 @@ <h3>args</h3>
143148
<li class="globals ">
144149
<a href="../globals.html"><em>Globals</em></a>
145150
</li>
151+
<li class="current tsd-kind-external-module">
152+
<a href="../modules/_src_metadata_facet_.html">&quot;src/metadata/facet&quot;</a>
153+
</li>
146154
</ul>
147155
</nav>
148156
<nav class="tsd-navigation secondary menu-sticky">
149157
<ul class="before-current">
150158
</ul>
151159
<ul class="current">
152-
<li class="current tsd-kind-class">
153-
<a href="facetmetadata.html" class="tsd-kind-icon">Facet<wbr>Metadata</a>
160+
<li class="current tsd-kind-class tsd-parent-kind-external-module">
161+
<a href="_src_metadata_facet_.facetmetadata.html" class="tsd-kind-icon">Facet<wbr>Metadata</a>
154162
<ul>
155163
<li class=" tsd-kind-interface tsd-parent-kind-class">
156-
<a href="../interfaces/facetmetadata.iargs.html" class="tsd-kind-icon">IArgs</a>
164+
<a href="../interfaces/_src_metadata_facet_.facetmetadata.iargs.html" class="tsd-kind-icon">IArgs</a>
157165
</li>
158166
<li class=" tsd-kind-constructor tsd-parent-kind-class">
159-
<a href="facetmetadata.html#constructor" class="tsd-kind-icon">constructor</a>
167+
<a href="_src_metadata_facet_.facetmetadata.html#constructor" class="tsd-kind-icon">constructor</a>
160168
</li>
161169
<li class=" tsd-kind-property tsd-parent-kind-class">
162-
<a href="facetmetadata.html#args" class="tsd-kind-icon">args</a>
170+
<a href="_src_metadata_facet_.facetmetadata.html#args" class="tsd-kind-icon">args</a>
163171
</li>
164172
</ul>
165173
</li>

docs/classes/nodemetadata.html renamed to docs/classes/_src_metadata_node_.nodemetadata.html

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>NodeMetadata | dgraph-orm</title>
6+
<title>NodeMetadata | @xanthous/dgraph-orm</title>
77
<meta name="description" content="">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
@@ -22,7 +22,7 @@
2222
<li class="state loading">Preparing search index...</li>
2323
<li class="state failure">The search index is not available</li>
2424
</ul>
25-
<a href="../index.html" class="title">dgraph-orm</a>
25+
<a href="../index.html" class="title">@xanthous/dgraph-orm</a>
2626
</div>
2727
<div class="table-cell" id="tsd-widgets">
2828
<div id="tsd-filter">
@@ -38,6 +38,8 @@
3838
</div>
3939
<input type="checkbox" id="tsd-filter-inherited" checked />
4040
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41+
<input type="checkbox" id="tsd-filter-externals" checked />
42+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
4143
<input type="checkbox" id="tsd-filter-only-exported" />
4244
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
4345
</div>
@@ -54,7 +56,10 @@
5456
<a href="../globals.html">Globals</a>
5557
</li>
5658
<li>
57-
<a href="nodemetadata.html">NodeMetadata</a>
59+
<a href="../modules/_src_metadata_node_.html">&quot;src/metadata/node&quot;</a>
60+
</li>
61+
<li>
62+
<a href="_src_metadata_node_.nodemetadata.html">NodeMetadata</a>
5863
</li>
5964
</ul>
6065
<h1>Class NodeMetadata</h1>
@@ -79,19 +84,19 @@ <h2>Index</h2>
7984
<section class="tsd-index-section ">
8085
<h3>Interfaces</h3>
8186
<ul class="tsd-index-list">
82-
<li class="tsd-kind-interface tsd-parent-kind-class"><a href="../interfaces/nodemetadata.iargs.html" class="tsd-kind-icon">IArgs</a></li>
87+
<li class="tsd-kind-interface tsd-parent-kind-class"><a href="../interfaces/_src_metadata_node_.nodemetadata.iargs.html" class="tsd-kind-icon">IArgs</a></li>
8388
</ul>
8489
</section>
8590
<section class="tsd-index-section ">
8691
<h3>Constructors</h3>
8792
<ul class="tsd-index-list">
88-
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="nodemetadata.html#constructor" class="tsd-kind-icon">constructor</a></li>
93+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_src_metadata_node_.nodemetadata.html#constructor" class="tsd-kind-icon">constructor</a></li>
8994
</ul>
9095
</section>
9196
<section class="tsd-index-section ">
9297
<h3>Properties</h3>
9398
<ul class="tsd-index-list">
94-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="nodemetadata.html#args" class="tsd-kind-icon">args</a></li>
99+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_src_metadata_node_.nodemetadata.html#args" class="tsd-kind-icon">args</a></li>
95100
</ul>
96101
</section>
97102
</div>
@@ -103,22 +108,22 @@ <h2>Constructors</h2>
103108
<a name="constructor" class="tsd-anchor"></a>
104109
<h3>constructor</h3>
105110
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
106-
<li class="tsd-signature tsd-kind-icon">new <wbr>Node<wbr>Metadata<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><a href="../interfaces/nodemetadata.iargs.html" class="tsd-signature-type">IArgs</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="nodemetadata.html" class="tsd-signature-type">NodeMetadata</a></li>
111+
<li class="tsd-signature tsd-kind-icon">new <wbr>Node<wbr>Metadata<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><a href="../interfaces/_src_metadata_node_.nodemetadata.iargs.html" class="tsd-signature-type">IArgs</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_metadata_node_.nodemetadata.html" class="tsd-signature-type">NodeMetadata</a></li>
107112
</ul>
108113
<ul class="tsd-descriptions">
109114
<li class="tsd-description">
110115
<aside class="tsd-sources">
111116
<ul>
112-
<li>Defined in <a href="https://github.com/osmanmesutozcan/dgraph-orm/blob/1f5658d/src/metadata/node.ts#L1">src/metadata/node.ts:1</a></li>
117+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/8fe25af/src/metadata/node.ts#L1">src/metadata/node.ts:1</a></li>
113118
</ul>
114119
</aside>
115120
<h4 class="tsd-parameters-title">Parameters</h4>
116121
<ul class="tsd-parameters">
117122
<li>
118-
<h5>args: <a href="../interfaces/nodemetadata.iargs.html" class="tsd-signature-type">IArgs</a></h5>
123+
<h5>args: <a href="../interfaces/_src_metadata_node_.nodemetadata.iargs.html" class="tsd-signature-type">IArgs</a></h5>
119124
</li>
120125
</ul>
121-
<h4 class="tsd-returns-title">Returns <a href="nodemetadata.html" class="tsd-signature-type">NodeMetadata</a></h4>
126+
<h4 class="tsd-returns-title">Returns <a href="_src_metadata_node_.nodemetadata.html" class="tsd-signature-type">NodeMetadata</a></h4>
122127
</li>
123128
</ul>
124129
</section>
@@ -128,10 +133,10 @@ <h2>Properties</h2>
128133
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
129134
<a name="args" class="tsd-anchor"></a>
130135
<h3>args</h3>
131-
<div class="tsd-signature tsd-kind-icon">args<span class="tsd-signature-symbol">:</span> <a href="../interfaces/nodemetadata.iargs.html" class="tsd-signature-type">IArgs</a></div>
136+
<div class="tsd-signature tsd-kind-icon">args<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_src_metadata_node_.nodemetadata.iargs.html" class="tsd-signature-type">IArgs</a></div>
132137
<aside class="tsd-sources">
133138
<ul>
134-
<li>Defined in <a href="https://github.com/osmanmesutozcan/dgraph-orm/blob/1f5658d/src/metadata/node.ts#L2">src/metadata/node.ts:2</a></li>
139+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/8fe25af/src/metadata/node.ts#L2">src/metadata/node.ts:2</a></li>
135140
</ul>
136141
</aside>
137142
</section>
@@ -143,23 +148,26 @@ <h3>args</h3>
143148
<li class="globals ">
144149
<a href="../globals.html"><em>Globals</em></a>
145150
</li>
151+
<li class="current tsd-kind-external-module">
152+
<a href="../modules/_src_metadata_node_.html">&quot;src/metadata/node&quot;</a>
153+
</li>
146154
</ul>
147155
</nav>
148156
<nav class="tsd-navigation secondary menu-sticky">
149157
<ul class="before-current">
150158
</ul>
151159
<ul class="current">
152-
<li class="current tsd-kind-class">
153-
<a href="nodemetadata.html" class="tsd-kind-icon">Node<wbr>Metadata</a>
160+
<li class="current tsd-kind-class tsd-parent-kind-external-module">
161+
<a href="_src_metadata_node_.nodemetadata.html" class="tsd-kind-icon">Node<wbr>Metadata</a>
154162
<ul>
155163
<li class=" tsd-kind-interface tsd-parent-kind-class">
156-
<a href="../interfaces/nodemetadata.iargs.html" class="tsd-kind-icon">IArgs</a>
164+
<a href="../interfaces/_src_metadata_node_.nodemetadata.iargs.html" class="tsd-kind-icon">IArgs</a>
157165
</li>
158166
<li class=" tsd-kind-constructor tsd-parent-kind-class">
159-
<a href="nodemetadata.html#constructor" class="tsd-kind-icon">constructor</a>
167+
<a href="_src_metadata_node_.nodemetadata.html#constructor" class="tsd-kind-icon">constructor</a>
160168
</li>
161169
<li class=" tsd-kind-property tsd-parent-kind-class">
162-
<a href="nodemetadata.html#args" class="tsd-kind-icon">args</a>
170+
<a href="_src_metadata_node_.nodemetadata.html#args" class="tsd-kind-icon">args</a>
163171
</li>
164172
</ul>
165173
</li>

0 commit comments

Comments
 (0)