Skip to content

Commit 80a1e45

Browse files
osmanmesutozcanosmanmesutozcan
committed
update docs
1 parent d64c368 commit 80a1e45

Some content is hidden

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

55 files changed

+327
-287
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/circulartracker.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2412,7 +2412,7 @@ <h3>is<wbr>Visited</h3>
24122412
<li class="tsd-description">
24132413
<aside class="tsd-sources">
24142414
<ul>
2415-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/utils/circular-tracker.ts#L4">src/utils/circular-tracker.ts:4</a></li>
2415+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/utils/circular-tracker.ts#L4">src/utils/circular-tracker.ts:4</a></li>
24162416
</ul>
24172417
</aside>
24182418
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2438,7 +2438,7 @@ <h3>mark<wbr>Visited</h3>
24382438
<li class="tsd-description">
24392439
<aside class="tsd-sources">
24402440
<ul>
2441-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/utils/circular-tracker.ts#L8">src/utils/circular-tracker.ts:8</a></li>
2441+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/utils/circular-tracker.ts#L8">src/utils/circular-tracker.ts:8</a></li>
24422442
</ul>
24432443
</aside>
24442444
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/diffenvelope.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2435,7 +2435,7 @@ <h3>deletes</h3>
24352435
<aside class="tsd-sources">
24362436
<p>Implementation of <a href="../interfaces/idiffenvelope.html">IDiffEnvelope</a>.<a href="../interfaces/idiffenvelope.html#deletes">deletes</a></p>
24372437
<ul>
2438-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/transaction.ts#L419">src/transaction/transaction.ts:419</a></li>
2438+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/transaction.ts#L416">src/transaction/transaction.ts:416</a></li>
24392439
</ul>
24402440
</aside>
24412441
</section>
@@ -2446,7 +2446,7 @@ <h3>facets</h3>
24462446
<aside class="tsd-sources">
24472447
<p>Implementation of <a href="../interfaces/idiffenvelope.html">IDiffEnvelope</a>.<a href="../interfaces/idiffenvelope.html#facets">facets</a></p>
24482448
<ul>
2449-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/transaction.ts#L415">src/transaction/transaction.ts:415</a></li>
2449+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/transaction.ts#L412">src/transaction/transaction.ts:412</a></li>
24502450
</ul>
24512451
</aside>
24522452
</section>
@@ -2457,7 +2457,7 @@ <h3>global<wbr>Deletes</h3>
24572457
<aside class="tsd-sources">
24582458
<p>Implementation of <a href="../interfaces/idiffenvelope.html">IDiffEnvelope</a>.<a href="../interfaces/idiffenvelope.html#globaldeletes">globalDeletes</a></p>
24592459
<ul>
2460-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/transaction.ts#L418">src/transaction/transaction.ts:418</a></li>
2460+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/transaction.ts#L415">src/transaction/transaction.ts:415</a></li>
24612461
</ul>
24622462
</aside>
24632463
</section>
@@ -2468,7 +2468,7 @@ <h3>predicates</h3>
24682468
<aside class="tsd-sources">
24692469
<p>Implementation of <a href="../interfaces/idiffenvelope.html">IDiffEnvelope</a>.<a href="../interfaces/idiffenvelope.html#predicates">predicates</a></p>
24702470
<ul>
2471-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/transaction.ts#L420">src/transaction/transaction.ts:420</a></li>
2471+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/transaction.ts#L417">src/transaction/transaction.ts:417</a></li>
24722472
</ul>
24732473
</aside>
24742474
</section>
@@ -2479,7 +2479,7 @@ <h3>properties</h3>
24792479
<aside class="tsd-sources">
24802480
<p>Implementation of <a href="../interfaces/idiffenvelope.html">IDiffEnvelope</a>.<a href="../interfaces/idiffenvelope.html#properties">properties</a></p>
24812481
<ul>
2482-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/transaction.ts#L416">src/transaction/transaction.ts:416</a></li>
2482+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/transaction.ts#L413">src/transaction/transaction.ts:413</a></li>
24832483
</ul>
24842484
</aside>
24852485
</section>

‎docs/classes/difftracker.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2428,7 +2428,7 @@ <h3>get<wbr>Deletes</h3>
24282428
<li class="tsd-description">
24292429
<aside class="tsd-sources">
24302430
<ul>
2431-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L94">src/transaction/diff-tracker.ts:94</a></li>
2431+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L95">src/transaction/diff-tracker.ts:95</a></li>
24322432
</ul>
24332433
</aside>
24342434
<div class="tsd-comment tsd-typography">
@@ -2456,7 +2456,7 @@ <h3>get<wbr>Instances<wbr>Iterable</h3>
24562456
<li class="tsd-description">
24572457
<aside class="tsd-sources">
24582458
<ul>
2459-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L113">src/transaction/diff-tracker.ts:113</a></li>
2459+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L114">src/transaction/diff-tracker.ts:114</a></li>
24602460
</ul>
24612461
</aside>
24622462
<div class="tsd-comment tsd-typography">
@@ -2478,7 +2478,7 @@ <h3>get<wbr>Sets</h3>
24782478
<li class="tsd-description">
24792479
<aside class="tsd-sources">
24802480
<ul>
2481-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L75">src/transaction/diff-tracker.ts:75</a></li>
2481+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L76">src/transaction/diff-tracker.ts:76</a></li>
24822482
</ul>
24832483
</aside>
24842484
<div class="tsd-comment tsd-typography">
@@ -2506,7 +2506,7 @@ <h3>get<wbr>Tracked<wbr>Properties</h3>
25062506
<li class="tsd-description">
25072507
<aside class="tsd-sources">
25082508
<ul>
2509-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L63">src/transaction/diff-tracker.ts:63</a></li>
2509+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L64">src/transaction/diff-tracker.ts:64</a></li>
25102510
</ul>
25112511
</aside>
25122512
<div class="tsd-comment tsd-typography">
@@ -2534,7 +2534,7 @@ <h3>purge<wbr>Instance</h3>
25342534
<li class="tsd-description">
25352535
<aside class="tsd-sources">
25362536
<ul>
2537-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L49">src/transaction/diff-tracker.ts:49</a></li>
2537+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L50">src/transaction/diff-tracker.ts:50</a></li>
25382538
</ul>
25392539
</aside>
25402540
<div class="tsd-comment tsd-typography">
@@ -2562,7 +2562,7 @@ <h3>track<wbr>Property</h3>
25622562
<li class="tsd-description">
25632563
<aside class="tsd-sources">
25642564
<ul>
2565-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L21">src/transaction/diff-tracker.ts:21</a></li>
2565+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L21">src/transaction/diff-tracker.ts:21</a></li>
25662566
</ul>
25672567
</aside>
25682568
<div class="tsd-comment tsd-typography">

‎docs/classes/diffvalue.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2458,7 +2458,7 @@ <h3>constructor</h3>
24582458
<li class="tsd-description">
24592459
<aside class="tsd-sources">
24602460
<ul>
2461-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L137">src/transaction/diff-tracker.ts:137</a></li>
2461+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L138">src/transaction/diff-tracker.ts:138</a></li>
24622462
</ul>
24632463
</aside>
24642464
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2480,7 +2480,7 @@ <h3>key</h3>
24802480
<div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
24812481
<aside class="tsd-sources">
24822482
<ul>
2483-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L139">src/transaction/diff-tracker.ts:139</a></li>
2483+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L140">src/transaction/diff-tracker.ts:140</a></li>
24842484
</ul>
24852485
</aside>
24862486
</section>
@@ -2497,7 +2497,7 @@ <h3>dirty</h3>
24972497
<li class="tsd-description">
24982498
<aside class="tsd-sources">
24992499
<ul>
2500-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L143">src/transaction/diff-tracker.ts:143</a></li>
2500+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L144">src/transaction/diff-tracker.ts:144</a></li>
25012501
</ul>
25022502
</aside>
25032503
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
@@ -2517,7 +2517,7 @@ <h3>clear</h3>
25172517
<li class="tsd-description">
25182518
<aside class="tsd-sources">
25192519
<ul>
2520-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L147">src/transaction/diff-tracker.ts:147</a></li>
2520+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L148">src/transaction/diff-tracker.ts:148</a></li>
25212521
</ul>
25222522
</aside>
25232523
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -2534,7 +2534,7 @@ <h3>get</h3>
25342534
<li class="tsd-description">
25352535
<aside class="tsd-sources">
25362536
<ul>
2537-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L156">src/transaction/diff-tracker.ts:156</a></li>
2537+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L157">src/transaction/diff-tracker.ts:157</a></li>
25382538
</ul>
25392539
</aside>
25402540
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
@@ -2551,7 +2551,7 @@ <h3>set</h3>
25512551
<li class="tsd-description">
25522552
<aside class="tsd-sources">
25532553
<ul>
2554-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/transaction/diff-tracker.ts#L151">src/transaction/diff-tracker.ts:151</a></li>
2554+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/transaction/diff-tracker.ts#L152">src/transaction/diff-tracker.ts:152</a></li>
25552555
</ul>
25562556
</aside>
25572557
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/facetmetadata.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2426,7 +2426,7 @@ <h3>constructor</h3>
24262426
<li class="tsd-description">
24272427
<aside class="tsd-sources">
24282428
<ul>
2429-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/metadata/facet.ts#L1">src/metadata/facet.ts:1</a></li>
2429+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/metadata/facet.ts#L1">src/metadata/facet.ts:1</a></li>
24302430
</ul>
24312431
</aside>
24322432
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2448,7 +2448,7 @@ <h3>args</h3>
24482448
<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>
24492449
<aside class="tsd-sources">
24502450
<ul>
2451-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/metadata/facet.ts#L2">src/metadata/facet.ts:2</a></li>
2451+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/metadata/facet.ts#L2">src/metadata/facet.ts:2</a></li>
24522452
</ul>
24532453
</aside>
24542454
</section>

‎docs/classes/indexmetadata.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2426,7 +2426,7 @@ <h3>constructor</h3>
24262426
<li class="tsd-description">
24272427
<aside class="tsd-sources">
24282428
<ul>
2429-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/metadata/property.ts#L42">src/metadata/property.ts:42</a></li>
2429+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/metadata/property.ts#L47">src/metadata/property.ts:47</a></li>
24302430
</ul>
24312431
</aside>
24322432
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2448,7 +2448,7 @@ <h3>args</h3>
24482448
<div class="tsd-signature tsd-kind-icon">args<span class="tsd-signature-symbol">:</span> <a href="../interfaces/indexmetadata.iargs.html" class="tsd-signature-type">IArgs</a></div>
24492449
<aside class="tsd-sources">
24502450
<ul>
2451-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/metadata/property.ts#L43">src/metadata/property.ts:43</a></li>
2451+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/metadata/property.ts#L48">src/metadata/property.ts:48</a></li>
24522452
</ul>
24532453
</aside>
24542454
</section>

‎docs/classes/iterableweakmap.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2493,7 +2493,7 @@ <h3>iterable</h3>
24932493
<li class="tsd-description">
24942494
<aside class="tsd-sources">
24952495
<ul>
2496-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/utils/iterator.ts#L67">src/utils/iterator.ts:67</a></li>
2496+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/utils/iterator.ts#L67">src/utils/iterator.ts:67</a></li>
24972497
</ul>
24982498
</aside>
24992499
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -2514,7 +2514,7 @@ <h3>delete</h3>
25142514
<aside class="tsd-sources">
25152515
<p>Overrides WeakMap.delete</p>
25162516
<ul>
2517-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/utils/iterator.ts#L55">src/utils/iterator.ts:55</a></li>
2517+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/utils/iterator.ts#L55">src/utils/iterator.ts:55</a></li>
25182518
</ul>
25192519
</aside>
25202520
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2537,7 +2537,7 @@ <h3>dispose</h3>
25372537
<li class="tsd-description">
25382538
<aside class="tsd-sources">
25392539
<ul>
2540-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/utils/iterator.ts#L63">src/utils/iterator.ts:63</a></li>
2540+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/utils/iterator.ts#L63">src/utils/iterator.ts:63</a></li>
25412541
</ul>
25422542
</aside>
25432543
<div class="tsd-comment tsd-typography">
@@ -2560,7 +2560,7 @@ <h3>get</h3>
25602560
<aside class="tsd-sources">
25612561
<p>Overrides WeakMap.get</p>
25622562
<ul>
2563-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/utils/iterator.ts#L51">src/utils/iterator.ts:51</a></li>
2563+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/utils/iterator.ts#L51">src/utils/iterator.ts:51</a></li>
25642564
</ul>
25652565
</aside>
25662566
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -2608,7 +2608,7 @@ <h3>set</h3>
26082608
<aside class="tsd-sources">
26092609
<p>Overrides WeakMap.set</p>
26102610
<ul>
2611-
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/4650dd2/src/utils/iterator.ts#L46">src/utils/iterator.ts:46</a></li>
2611+
<li>Defined in <a href="https://github.com/xanthous-tech/dgraph-orm/blob/d64c368/src/utils/iterator.ts#L46">src/utils/iterator.ts:46</a></li>
26122612
</ul>
26132613
</aside>
26142614
<h4 class="tsd-parameters-title">Parameters</h4>

0 commit comments

Comments
 (0)