Skip to content

Commit 7df6a60

Browse files
committed
chore: update doc
1 parent e67a7d4 commit 7df6a60

File tree

87 files changed

+2898
-12612
lines changed

Some content is hidden

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

87 files changed

+2898
-12612
lines changed

docs/assets/css/main.css

Lines changed: 88 additions & 60 deletions
Large diffs are not rendered by default.

docs/assets/js/main.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/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/classes_filter.filter.html

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,10 @@ <h3>Hierarchy</h3>
8585
<h2>Index</h2>
8686
<section class="tsd-panel tsd-index-panel">
8787
<div class="tsd-index-content">
88-
<section class="tsd-index-section ">
88+
<section class="tsd-index-section tsd-is-inherited">
8989
<h3>Constructors</h3>
9090
<ul class="tsd-index-list">
91-
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="classes_filter.filter.html#constructor" class="tsd-kind-icon">constructor</a></li>
91+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="classes_filter.filter.html#constructor" class="tsd-kind-icon">constructor</a></li>
9292
</ul>
9393
</section>
9494
<section class="tsd-index-section ">
@@ -112,17 +112,18 @@ <h3>Methods</h3>
112112
</div>
113113
</section>
114114
</section>
115-
<section class="tsd-panel-group tsd-member-group ">
115+
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
116116
<h2>Constructors</h2>
117-
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
117+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
118118
<a name="constructor" class="tsd-anchor"></a>
119119
<h3>constructor</h3>
120-
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
120+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
121121
<li class="tsd-signature tsd-kind-icon">new <wbr>Filter<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes_filter.filter.html" class="tsd-signature-type" data-tsd-kind="Class">Filter</a></li>
122122
</ul>
123123
<ul class="tsd-descriptions">
124124
<li class="tsd-description">
125125
<aside class="tsd-sources">
126+
<p>Inherited from ISerializable.constructor</p>
126127
</aside>
127128
<h4 class="tsd-returns-title">Returns <a href="classes_filter.filter.html" class="tsd-signature-type" data-tsd-kind="Class">Filter</a></h4>
128129
</li>
@@ -137,17 +138,17 @@ <h3>limit</h3>
137138
<div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 50</span></div>
138139
<aside class="tsd-sources">
139140
<ul>
140-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/a1a6ffa/src/classes/filter.ts#L20">src/classes/filter.ts:20</a></li>
141+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/e67a7d4/src/classes/filter.ts#L20">src/classes/filter.ts:20</a></li>
141142
</ul>
142143
</aside>
143144
</section>
144145
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
145146
<a name="orderby" class="tsd-anchor"></a>
146147
<h3><span class="tsd-flag ts-flagOptional">Optional</span> order<wbr>By</h3>
147-
<div class="tsd-signature tsd-kind-icon">order<wbr>By<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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></div>
148+
<div class="tsd-signature tsd-kind-icon">order<wbr>By<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></div>
148149
<aside class="tsd-sources">
149150
<ul>
150-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/a1a6ffa/src/classes/filter.ts#L28">src/classes/filter.ts:28</a></li>
151+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/e67a7d4/src/classes/filter.ts#L28">src/classes/filter.ts:28</a></li>
151152
</ul>
152153
</aside>
153154
</section>
@@ -158,7 +159,7 @@ <h3>serialize</h3>
158159
<aside class="tsd-sources">
159160
<p>Inherited from <a href="../interfaces/serializer.iserializable.html">ISerializable</a>.<a href="../interfaces/serializer.iserializable.html#serialize">serialize</a></p>
160161
<ul>
161-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/a1a6ffa/src/serializer.ts#L5">src/serializer.ts:5</a></li>
162+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/e67a7d4/src/serializer.ts#L5">src/serializer.ts:5</a></li>
162163
</ul>
163164
</aside>
164165
<div class="tsd-type-declaration">
@@ -183,7 +184,7 @@ <h3>skip</h3>
183184
<div class="tsd-signature tsd-kind-icon">skip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
184185
<aside class="tsd-sources">
185186
<ul>
186-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/a1a6ffa/src/classes/filter.ts#L13">src/classes/filter.ts:13</a></li>
187+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/e67a7d4/src/classes/filter.ts#L13">src/classes/filter.ts:13</a></li>
187188
</ul>
188189
</aside>
189190
</section>
@@ -194,7 +195,7 @@ <h3>toJSON</h3>
194195
<aside class="tsd-sources">
195196
<p>Inherited from <a href="../interfaces/serializer.iserializable.html">ISerializable</a>.<a href="../interfaces/serializer.iserializable.html#tojson">toJSON</a></p>
196197
<ul>
197-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/a1a6ffa/src/serializer.ts#L6">src/serializer.ts:6</a></li>
198+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/e67a7d4/src/serializer.ts#L6">src/serializer.ts:6</a></li>
198199
</ul>
199200
</aside>
200201
<div class="tsd-type-declaration">
@@ -226,7 +227,7 @@ <h3>get<wbr>Sort</h3>
226227
<li class="tsd-description">
227228
<aside class="tsd-sources">
228229
<ul>
229-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/a1a6ffa/src/classes/filter.ts#L30">src/classes/filter.ts:30</a></li>
230+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/e67a7d4/src/classes/filter.ts#L30">src/classes/filter.ts:30</a></li>
230231
</ul>
231232
</aside>
232233
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">1</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">-1</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span></h4>
@@ -243,7 +244,7 @@ <h3>get<wbr>Sort<wbr>For<wbr>Aggregation</h3>
243244
<li class="tsd-description">
244245
<aside class="tsd-sources">
245246
<ul>
246-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/a1a6ffa/src/classes/filter.ts#L43">src/classes/filter.ts:43</a></li>
247+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/e67a7d4/src/classes/filter.ts#L43">src/classes/filter.ts:43</a></li>
247248
</ul>
248249
</aside>
249250
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{}</span></h4>
@@ -265,7 +266,7 @@ <h3>to<wbr>Query</h3>
265266
<li class="tsd-description">
266267
<aside class="tsd-sources">
267268
<ul>
268-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/a1a6ffa/src/classes/filter.ts#L58">src/classes/filter.ts:58</a></li>
269+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/e67a7d4/src/classes/filter.ts#L58">src/classes/filter.ts:58</a></li>
269270
</ul>
270271
</aside>
271272
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
@@ -292,7 +293,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span
292293
<li class="current tsd-kind-class tsd-parent-kind-module">
293294
<a href="classes_filter.filter.html" class="tsd-kind-icon">Filter</a>
294295
<ul>
295-
<li class=" tsd-kind-constructor tsd-parent-kind-class">
296+
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
296297
<a href="classes_filter.filter.html#constructor" class="tsd-kind-icon">constructor</a>
297298
</li>
298299
<li class=" tsd-kind-property tsd-parent-kind-class">
@@ -342,7 +343,6 @@ <h2>Legend</h2>
342343
<ul class="tsd-legend">
343344
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
344345
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
345-
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
346346
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
347347
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
348348
</ul>
@@ -351,10 +351,11 @@ <h2>Legend</h2>
351351
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
352352
</ul>
353353
<ul class="tsd-legend">
354-
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
354+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
355+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
355356
</ul>
356357
<ul class="tsd-legend">
357-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
358+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
358359
</ul>
359360
</div>
360361
</div>

0 commit comments

Comments
 (0)