Skip to content

Commit cc472a6

Browse files
author
Checkiteasy
committed
add doc
1 parent 3bab440 commit cc472a6

File tree

65 files changed

+15009
-4
lines changed

Some content is hidden

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

65 files changed

+15009
-4
lines changed

‎README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@ import { MongoModule } from 'nestjs-mongo';
3333
export class MyModule {}
3434
```
3535

36-
TODO, write doc.
37-
3836
### Documentation
3937

4038
A typedoc is generated and available on github [https://pop-code.github.io/nestjs-mongo][doc-link]
@@ -43,7 +41,7 @@ A typedoc is generated and available on github [https://pop-code.github.io/nestj
4341

4442
#### TODO
4543

46-
- [ ] write docs
44+
- [ ] write wiki
4745
- [ ] add more tests
4846
- [ ] add examples
4947

‎docs/.nojekyll

Whitespace-only changes.

‎docs/assets/css/main.css

Lines changed: 865 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/assets/css/main.css.map

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/assets/images/icons.png

9.26 KB
Loading

‎docs/assets/images/icons@2x.png

27.1 KB
Loading

‎docs/assets/images/widgets.png

480 Bytes
Loading

‎docs/assets/images/widgets@2x.png

855 Bytes
Loading

‎docs/assets/js/main.js

Lines changed: 5 additions & 0 deletions
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: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/_classes_history_.historyactions.html

Lines changed: 312 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/classes/_classes_history_action_.historyaction.html

Lines changed: 252 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,252 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>HistoryAction | NestJS Mongo</title>
7+
<meta name="description" content="">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="../assets/css/main.css">
10+
</head>
11+
<body>
12+
<header>
13+
<div class="tsd-page-toolbar">
14+
<div class="container">
15+
<div class="table-wrap">
16+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17+
<div class="field">
18+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19+
<input id="tsd-search-field" type="text" />
20+
</div>
21+
<ul class="results">
22+
<li class="state loading">Preparing search index...</li>
23+
<li class="state failure">The search index is not available</li>
24+
</ul>
25+
<a href="../index.html" class="title">NestJS Mongo</a>
26+
</div>
27+
<div class="table-cell" id="tsd-widgets">
28+
<div id="tsd-filter">
29+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30+
<div class="tsd-filter-group">
31+
<div class="tsd-select" id="tsd-filter-visibility">
32+
<span class="tsd-select-label">All</span>
33+
<ul class="tsd-select-list">
34+
<li data-value="public">Public</li>
35+
<li data-value="protected">Public/Protected</li>
36+
<li data-value="private" class="selected">All</li>
37+
</ul>
38+
</div>
39+
<input type="checkbox" id="tsd-filter-inherited" checked />
40+
<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>
43+
<input type="checkbox" id="tsd-filter-only-exported" />
44+
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45+
</div>
46+
</div>
47+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48+
</div>
49+
</div>
50+
</div>
51+
</div>
52+
<div class="tsd-page-title">
53+
<div class="container">
54+
<ul class="tsd-breadcrumb">
55+
<li>
56+
<a href="../globals.html">Globals</a>
57+
</li>
58+
<li>
59+
<a href="../modules/_classes_history_action_.html">&quot;classes/history.action&quot;</a>
60+
</li>
61+
<li>
62+
<a href="_classes_history_action_.historyaction.html">HistoryAction</a>
63+
</li>
64+
</ul>
65+
<h1>Class HistoryAction</h1>
66+
</div>
67+
</div>
68+
</header>
69+
<div class="container container-main">
70+
<div class="row">
71+
<div class="col-8 col-content">
72+
<section class="tsd-panel tsd-hierarchy">
73+
<h3>Hierarchy</h3>
74+
<ul class="tsd-hierarchy">
75+
<li>
76+
<span class="target">HistoryAction</span>
77+
</li>
78+
</ul>
79+
</section>
80+
<section class="tsd-panel-group tsd-index-group">
81+
<h2>Index</h2>
82+
<section class="tsd-panel tsd-index-panel">
83+
<div class="tsd-index-content">
84+
<section class="tsd-index-section ">
85+
<h3>Constructors</h3>
86+
<ul class="tsd-index-list">
87+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_classes_history_action_.historyaction.html#constructor" class="tsd-kind-icon">constructor</a></li>
88+
</ul>
89+
</section>
90+
<section class="tsd-index-section ">
91+
<h3>Properties</h3>
92+
<ul class="tsd-index-list">
93+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_classes_history_action_.historyaction.html#action" class="tsd-kind-icon">action</a></li>
94+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_classes_history_action_.historyaction.html#date" class="tsd-kind-icon">date</a></li>
95+
</ul>
96+
</section>
97+
</div>
98+
</section>
99+
</section>
100+
<section class="tsd-panel-group tsd-member-group ">
101+
<h2>Constructors</h2>
102+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
103+
<a name="constructor" class="tsd-anchor"></a>
104+
<h3>constructor</h3>
105+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
106+
<li class="tsd-signature tsd-kind-icon">new <wbr>History<wbr>Action<span class="tsd-signature-symbol">(</span>action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_classes_history_action_.historyaction.html" class="tsd-signature-type">HistoryAction</a></li>
107+
</ul>
108+
<ul class="tsd-descriptions">
109+
<li class="tsd-description">
110+
<aside class="tsd-sources">
111+
<ul>
112+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/3bab440/src/classes/history.action.ts#L21">classes/history.action.ts:21</a></li>
113+
</ul>
114+
</aside>
115+
<h4 class="tsd-parameters-title">Parameters</h4>
116+
<ul class="tsd-parameters">
117+
<li>
118+
<h5>action: <span class="tsd-signature-type">string</span></h5>
119+
</li>
120+
<li>
121+
<h5>date: <span class="tsd-signature-type">Date</span></h5>
122+
</li>
123+
</ul>
124+
<h4 class="tsd-returns-title">Returns <a href="_classes_history_action_.historyaction.html" class="tsd-signature-type">HistoryAction</a></h4>
125+
</li>
126+
</ul>
127+
</section>
128+
</section>
129+
<section class="tsd-panel-group tsd-member-group ">
130+
<h2>Properties</h2>
131+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
132+
<a name="action" class="tsd-anchor"></a>
133+
<h3>action</h3>
134+
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
135+
<aside class="tsd-sources">
136+
<ul>
137+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/3bab440/src/classes/history.action.ts#L13">classes/history.action.ts:13</a></li>
138+
</ul>
139+
</aside>
140+
</section>
141+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
142+
<a name="date" class="tsd-anchor"></a>
143+
<h3>date</h3>
144+
<div class="tsd-signature tsd-kind-icon">date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
145+
<aside class="tsd-sources">
146+
<ul>
147+
<li>Defined in <a href="https://github.com/Pop-Code/nestjs-mongo/blob/3bab440/src/classes/history.action.ts#L21">classes/history.action.ts:21</a></li>
148+
</ul>
149+
</aside>
150+
</section>
151+
</section>
152+
</div>
153+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
154+
<nav class="tsd-navigation primary">
155+
<ul>
156+
<li class="globals ">
157+
<a href="../globals.html"><em>Globals</em></a>
158+
</li>
159+
<li class="current tsd-kind-external-module">
160+
<a href="../modules/_classes_history_action_.html">"classes/history.action"</a>
161+
</li>
162+
</ul>
163+
</nav>
164+
<nav class="tsd-navigation secondary menu-sticky">
165+
<ul class="before-current">
166+
</ul>
167+
<ul class="current">
168+
<li class="current tsd-kind-class tsd-parent-kind-external-module">
169+
<a href="_classes_history_action_.historyaction.html" class="tsd-kind-icon">History<wbr>Action</a>
170+
<ul>
171+
<li class=" tsd-kind-constructor tsd-parent-kind-class">
172+
<a href="_classes_history_action_.historyaction.html#constructor" class="tsd-kind-icon">constructor</a>
173+
</li>
174+
<li class=" tsd-kind-property tsd-parent-kind-class">
175+
<a href="_classes_history_action_.historyaction.html#action" class="tsd-kind-icon">action</a>
176+
</li>
177+
<li class=" tsd-kind-property tsd-parent-kind-class">
178+
<a href="_classes_history_action_.historyaction.html#date" class="tsd-kind-icon">date</a>
179+
</li>
180+
</ul>
181+
</li>
182+
</ul>
183+
<ul class="after-current">
184+
</ul>
185+
</nav>
186+
</div>
187+
</div>
188+
</div>
189+
<footer>
190+
<div class="container">
191+
<h2>Legend</h2>
192+
<div class="tsd-legend-group">
193+
<ul class="tsd-legend">
194+
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
195+
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
196+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
197+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
198+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
199+
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
200+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
201+
</ul>
202+
<ul class="tsd-legend">
203+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
204+
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
205+
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
206+
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
207+
</ul>
208+
<ul class="tsd-legend">
209+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
210+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
211+
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
212+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
213+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
214+
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
215+
</ul>
216+
<ul class="tsd-legend">
217+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
218+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
219+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
220+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
221+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
222+
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
223+
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
224+
</ul>
225+
<ul class="tsd-legend">
226+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
227+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
228+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
229+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
230+
</ul>
231+
<ul class="tsd-legend">
232+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
233+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
234+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
235+
</ul>
236+
<ul class="tsd-legend">
237+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
238+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
239+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
240+
</ul>
241+
<ul class="tsd-legend">
242+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
243+
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
244+
</ul>
245+
</div>
246+
</div>
247+
</footer>
248+
<div class="overlay"></div>
249+
<script src="../assets/js/main.js"></script>
250+
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
251+
</body>
252+
</html>

0 commit comments

Comments
 (0)