Skip to content

Commit 38965df

Browse files
committed
chore: update doc
1 parent 7c4700d commit 38965df

File tree

92 files changed

+1143
-1076
lines changed

Some content is hidden

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

92 files changed

+1143
-1076
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/entity_entity.Entity.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>Entity | NestJS Mongo</title>
7-
<meta name="description" content="Documentation for NestJS Mongo">
6+
<title>Entity | NestJS Mongo - v0.12.0</title>
7+
<meta name="description" content="Documentation for NestJS Mongo - v0.12.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
1010
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
2323
<li class="state loading">Preparing search index...</li>
2424
<li class="state failure">The search index is not available</li>
2525
</ul>
26-
<a href="../index.html" class="title">NestJS Mongo</a>
26+
<a href="../index.html" class="title">NestJS Mongo - v0.12.0</a>
2727
</div>
2828
<div class="table-cell" id="tsd-widgets">
2929
<div id="tsd-filter">
@@ -52,7 +52,7 @@
5252
<div class="container">
5353
<ul class="tsd-breadcrumb">
5454
<li>
55-
<a href="../modules.html">NestJS Mongo</a>
55+
<a href="../modules.html">NestJS Mongo - v0.12.0</a>
5656
</li>
5757
<li>
5858
<a href="../modules/entity_entity.html">entity/entity</a>
@@ -142,7 +142,7 @@ <h3>_id</h3>
142142
<aside class="tsd-sources">
143143
<p>Implementation of <a href="../interfaces/entity_interfaces.EntityInterface.html">EntityInterface</a>.<a href="../interfaces/entity_interfaces.EntityInterface.html#_id">_id</a></p>
144144
<ul>
145-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/entity/entity.ts#L14">src/entity/entity.ts:14</a></li>
145+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/entity/entity.ts#L14">src/entity/entity.ts:14</a></li>
146146
</ul>
147147
</aside>
148148
</section>
@@ -153,7 +153,7 @@ <h3>created<wbr>At</h3>
153153
<aside class="tsd-sources">
154154
<p>Implementation of <a href="../interfaces/entity_interfaces.EntityInterface.html">EntityInterface</a>.<a href="../interfaces/entity_interfaces.EntityInterface.html#createdAt">createdAt</a></p>
155155
<ul>
156-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/entity/entity.ts#L18">src/entity/entity.ts:18</a></li>
156+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/entity/entity.ts#L18">src/entity/entity.ts:18</a></li>
157157
</ul>
158158
</aside>
159159
</section>
@@ -164,7 +164,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> updated<wbr>At</h3>
164164
<aside class="tsd-sources">
165165
<p>Implementation of <a href="../interfaces/entity_interfaces.EntityInterface.html">EntityInterface</a>.<a href="../interfaces/entity_interfaces.EntityInterface.html#updatedAt">updatedAt</a></p>
166166
<ul>
167-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/entity/entity.ts#L23">src/entity/entity.ts:23</a></li>
167+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/entity/entity.ts#L23">src/entity/entity.ts:23</a></li>
168168
</ul>
169169
</aside>
170170
</section>
@@ -182,7 +182,7 @@ <h3>serialize</h3>
182182
<aside class="tsd-sources">
183183
<p>Inherited from <a href="../interfaces/serializer_interfaces.SerializableInterface.html">SerializableInterface</a>.<a href="../interfaces/serializer_interfaces.SerializableInterface.html#serialize">serialize</a></p>
184184
<ul>
185-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/serializer/interfaces.ts#L5">src/serializer/interfaces.ts:5</a></li>
185+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/serializer/interfaces.ts#L5">src/serializer/interfaces.ts:5</a></li>
186186
</ul>
187187
</aside>
188188
<div class="tsd-comment tsd-typography">
@@ -205,7 +205,7 @@ <h3>toJSON</h3>
205205
<aside class="tsd-sources">
206206
<p>Inherited from <a href="../interfaces/serializer_interfaces.SerializableInterface.html">SerializableInterface</a>.<a href="../interfaces/serializer_interfaces.SerializableInterface.html#toJSON">toJSON</a></p>
207207
<ul>
208-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/serializer/interfaces.ts#L10">src/serializer/interfaces.ts:10</a></li>
208+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/serializer/interfaces.ts#L10">src/serializer/interfaces.ts:10</a></li>
209209
</ul>
210210
</aside>
211211
<div class="tsd-comment tsd-typography">

docs/classes/entity_filter.Filter.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>Filter | NestJS Mongo</title>
7-
<meta name="description" content="Documentation for NestJS Mongo">
6+
<title>Filter | NestJS Mongo - v0.12.0</title>
7+
<meta name="description" content="Documentation for NestJS Mongo - v0.12.0">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
1010
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
2323
<li class="state loading">Preparing search index...</li>
2424
<li class="state failure">The search index is not available</li>
2525
</ul>
26-
<a href="../index.html" class="title">NestJS Mongo</a>
26+
<a href="../index.html" class="title">NestJS Mongo - v0.12.0</a>
2727
</div>
2828
<div class="table-cell" id="tsd-widgets">
2929
<div id="tsd-filter">
@@ -52,7 +52,7 @@
5252
<div class="container">
5353
<ul class="tsd-breadcrumb">
5454
<li>
55-
<a href="../modules.html">NestJS Mongo</a>
55+
<a href="../modules.html">NestJS Mongo - v0.12.0</a>
5656
</li>
5757
<li>
5858
<a href="../modules/entity_filter.html">entity/filter</a>
@@ -138,7 +138,7 @@ <h3>limit</h3>
138138
<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>
139139
<aside class="tsd-sources">
140140
<ul>
141-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/entity/filter.ts#L20">src/entity/filter.ts:20</a></li>
141+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/entity/filter.ts#L20">src/entity/filter.ts:20</a></li>
142142
</ul>
143143
</aside>
144144
</section>
@@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> order<wbr>By</h3>
148148
<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>
149149
<aside class="tsd-sources">
150150
<ul>
151-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/entity/filter.ts#L26">src/entity/filter.ts:26</a></li>
151+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/entity/filter.ts#L26">src/entity/filter.ts:26</a></li>
152152
</ul>
153153
</aside>
154154
</section>
@@ -158,7 +158,7 @@ <h3>skip</h3>
158158
<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>
159159
<aside class="tsd-sources">
160160
<ul>
161-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/entity/filter.ts#L13">src/entity/filter.ts:13</a></li>
161+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/entity/filter.ts#L13">src/entity/filter.ts:13</a></li>
162162
</ul>
163163
</aside>
164164
</section>
@@ -175,7 +175,7 @@ <h3>get<wbr>Sort</h3>
175175
<li class="tsd-description">
176176
<aside class="tsd-sources">
177177
<ul>
178-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/entity/filter.ts#L28">src/entity/filter.ts:28</a></li>
178+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/entity/filter.ts#L28">src/entity/filter.ts:28</a></li>
179179
</ul>
180180
</aside>
181181
<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>
@@ -192,7 +192,7 @@ <h3>get<wbr>Sort<wbr>For<wbr>Aggregation</h3>
192192
<li class="tsd-description">
193193
<aside class="tsd-sources">
194194
<ul>
195-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/entity/filter.ts#L41">src/entity/filter.ts:41</a></li>
195+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/entity/filter.ts#L41">src/entity/filter.ts:41</a></li>
196196
</ul>
197197
</aside>
198198
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{}</span></h4>
@@ -215,7 +215,7 @@ <h3>serialize</h3>
215215
<aside class="tsd-sources">
216216
<p>Inherited from <a href="../interfaces/serializer_interfaces.SerializableInterface.html">SerializableInterface</a>.<a href="../interfaces/serializer_interfaces.SerializableInterface.html#serialize">serialize</a></p>
217217
<ul>
218-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/serializer/interfaces.ts#L5">src/serializer/interfaces.ts:5</a></li>
218+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/serializer/interfaces.ts#L5">src/serializer/interfaces.ts:5</a></li>
219219
</ul>
220220
</aside>
221221
<div class="tsd-comment tsd-typography">
@@ -238,7 +238,7 @@ <h3>toJSON</h3>
238238
<aside class="tsd-sources">
239239
<p>Inherited from <a href="../interfaces/serializer_interfaces.SerializableInterface.html">SerializableInterface</a>.<a href="../interfaces/serializer_interfaces.SerializableInterface.html#toJSON">toJSON</a></p>
240240
<ul>
241-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/serializer/interfaces.ts#L10">src/serializer/interfaces.ts:10</a></li>
241+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/serializer/interfaces.ts#L10">src/serializer/interfaces.ts:10</a></li>
242242
</ul>
243243
</aside>
244244
<div class="tsd-comment tsd-typography">
@@ -260,7 +260,7 @@ <h3>to<wbr>Query</h3>
260260
<li class="tsd-description">
261261
<aside class="tsd-sources">
262262
<ul>
263-
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/ff25d62/src/entity/filter.ts#L56">src/entity/filter.ts:56</a></li>
263+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/7c4700d/src/entity/filter.ts#L56">src/entity/filter.ts:56</a></li>
264264
</ul>
265265
</aside>
266266
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>

0 commit comments

Comments
 (0)