Skip to content

Commit 1f2757b

Browse files
jankapunktjankapunkt
committed
docs: jsdoc updated
1 parent 768b9d0 commit 1f2757b

Some content is hidden

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

58 files changed

+29929
-0
lines changed

‎docs/AccountsPassword.html

+615
Large diffs are not rendered by default.

‎docs/Collection.html

+1,707
Large diffs are not rendered by default.

‎docs/Cursor.html

+922
Large diffs are not rendered by default.

‎docs/DDP.html

+1,098
Large diffs are not rendered by default.

‎docs/Data.html

+1,511
Large diffs are not rendered by default.

‎docs/Meteor.html

+748
Large diffs are not rendered by default.

‎docs/Mongo.html

+139
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>JSDoc: Namespace: Mongo</title>
6+
7+
<script src="scripts/prettify/prettify.js"> </script>
8+
<script src="scripts/prettify/lang-css.js"> </script>
9+
<!--[if lt IE 9]>
10+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11+
<![endif]-->
12+
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14+
</head>
15+
16+
<body>
17+
18+
<div id="main">
19+
20+
<h1 class="page-title">Namespace: Mongo</h1>
21+
22+
23+
24+
25+
26+
27+
<section>
28+
29+
<header>
30+
31+
<h2>Mongo</h2>
32+
33+
34+
</header>
35+
36+
<article>
37+
<div class="container-overview">
38+
39+
40+
<div class="description">Mongo namespace, contains only Mongo.Collection</div>
41+
42+
43+
44+
45+
46+
<dl class="details">
47+
48+
49+
50+
51+
52+
53+
54+
55+
56+
57+
58+
59+
60+
61+
62+
63+
64+
65+
66+
67+
68+
69+
70+
71+
72+
73+
<dt class="tag-source">Source:</dt>
74+
<dd class="tag-source"><ul class="dummy"><li>
75+
<a href="src_Mongo.js.html">src/Mongo.js</a>, <a href="src_Mongo.js.html#line3">line 3</a>
76+
</li></ul></dd>
77+
78+
79+
80+
81+
82+
<dt class="tag-see">See:</dt>
83+
<dd class="tag-see">
84+
<ul>
85+
<li><a href="Collection.html">Collection</a></li>
86+
</ul>
87+
</dd>
88+
89+
90+
91+
</dl>
92+
93+
94+
95+
96+
</div>
97+
98+
99+
100+
101+
102+
103+
104+
105+
106+
107+
108+
109+
110+
111+
112+
113+
114+
115+
116+
117+
</article>
118+
119+
</section>
120+
121+
122+
123+
124+
</div>
125+
126+
<nav>
127+
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="Data.html">Data</a></li><li><a href="Meteor.html">Meteor</a></li><li><a href="Mongo.html">Mongo</a></li><li><a href="Tracker.html">Tracker</a></li><li><a href="User.html">User</a></li></ul><h3>Classes</h3><ul><li><a href="AccountsPassword.html">AccountsPassword</a></li><li><a href="Collection.html">Collection</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="DDP.html">DDP</a></li><li><a href="MongoID.ObjectID.html">ObjectID</a></li><li><a href="Tracker.Computation.html">Computation</a></li><li><a href="Tracker.Dependency.html">Dependency</a></li><li><a href="module.html#.exports">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#MongoID">MongoID</a></li><li><a href="global.html#SHA256">SHA256</a></li><li><a href="global.html#close">close</a></li><li><a href="global.html#empty">empty</a></li><li><a href="global.html#getObservers">getObservers</a></li><li><a href="global.html#hasOwn">hasOwn</a></li><li><a href="global.html#hashPassword">hashPassword</a></li><li><a href="global.html#isPlainObject">isPlainObject</a></li><li><a href="global.html#isWindow">isWindow</a></li><li><a href="global.html#localCollections">localCollections</a></li><li><a href="global.html#open">open</a></li><li><a href="global.html#process">process</a></li><li><a href="global.html#push">push</a></li><li><a href="global.html#send">send</a></li><li><a href="global.html#stringify">stringify</a></li><li><a href="global.html#type">type</a></li><li><a href="global.html#uniqueId">uniqueId</a></li><li><a href="global.html#withNoYieldsAllowed">withNoYieldsAllowed</a></li></ul>
128+
</nav>
129+
130+
<br class="clear">
131+
132+
<footer>
133+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Apr 17 2024 08:46:35 GMT+0200 (Central European Summer Time)
134+
</footer>
135+
136+
<script> prettyPrint(); </script>
137+
<script src="scripts/linenumber.js"> </script>
138+
</body>
139+
</html>

‎docs/MongoID.ObjectID.html

+240
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,240 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>JSDoc: Class: ObjectID</title>
6+
7+
<script src="scripts/prettify/prettify.js"> </script>
8+
<script src="scripts/prettify/lang-css.js"> </script>
9+
<!--[if lt IE 9]>
10+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11+
<![endif]-->
12+
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14+
</head>
15+
16+
<body>
17+
18+
<div id="main">
19+
20+
<h1 class="page-title">Class: ObjectID</h1>
21+
22+
23+
24+
25+
26+
27+
<section>
28+
29+
<header>
30+
31+
<h2><span class="attribs"><span class="type-signature"></span></span>
32+
<span class="ancestors"><a href="global.html#MongoID">MongoID</a>.</span>ObjectID<span class="signature">(hexString<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
33+
34+
35+
</header>
36+
37+
<article>
38+
<div class="container-overview">
39+
40+
41+
42+
43+
44+
45+
<h4 class="name" id="ObjectID"><span class="type-signature"></span>new ObjectID<span class="signature">(hexString<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
46+
47+
48+
49+
50+
51+
52+
<div class="description">
53+
Create a Mongo-style ObjectID. If you don't specify a hexString,
54+
the ObjectID will be generated randomly (not using MongoDB's ID construction rules).
55+
</div>
56+
57+
58+
59+
60+
61+
62+
63+
64+
65+
<h5>Parameters:</h5>
66+
67+
68+
<table class="params">
69+
<thead>
70+
<tr>
71+
72+
<th>Name</th>
73+
74+
75+
<th>Type</th>
76+
77+
78+
<th>Attributes</th>
79+
80+
81+
82+
83+
<th class="last">Description</th>
84+
</tr>
85+
</thead>
86+
87+
<tbody>
88+
89+
90+
<tr>
91+
92+
<td class="name"><code>hexString</code></td>
93+
94+
95+
<td class="type">
96+
97+
98+
<span class="param-type">string</span>
99+
100+
101+
102+
</td>
103+
104+
105+
<td class="attributes">
106+
107+
&lt;optional><br>
108+
109+
110+
111+
112+
113+
</td>
114+
115+
116+
117+
118+
<td class="description last">Optional. The 24-character hexadecimal contents of the ObjectID to create</td>
119+
</tr>
120+
121+
122+
</tbody>
123+
</table>
124+
125+
126+
127+
128+
129+
130+
<dl class="details">
131+
132+
133+
134+
135+
136+
137+
138+
139+
140+
141+
142+
143+
144+
145+
146+
147+
148+
149+
150+
151+
152+
153+
154+
155+
156+
157+
<dt class="tag-source">Source:</dt>
158+
<dd class="tag-source"><ul class="dummy"><li>
159+
<a href="lib_mongo-id.js.html">lib/mongo-id.js</a>, <a href="lib_mongo-id.js.html#line24">line 24</a>
160+
</li></ul></dd>
161+
162+
163+
164+
165+
166+
<dt class="tag-see">See:</dt>
167+
<dd class="tag-see">
168+
<ul>
169+
<li><a href="https://docs.meteor.com/api/collections.html#Mongo-ObjectID">https://docs.meteor.com/api/collections.html#Mongo-ObjectID</a></li>
170+
</ul>
171+
</dd>
172+
173+
174+
175+
</dl>
176+
177+
178+
179+
180+
181+
182+
183+
184+
185+
186+
187+
188+
189+
190+
191+
192+
193+
194+
195+
196+
197+
</div>
198+
199+
200+
201+
202+
203+
204+
205+
206+
207+
208+
209+
210+
211+
212+
213+
214+
215+
216+
217+
218+
</article>
219+
220+
</section>
221+
222+
223+
224+
225+
</div>
226+
227+
<nav>
228+
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="Data.html">Data</a></li><li><a href="Meteor.html">Meteor</a></li><li><a href="Mongo.html">Mongo</a></li><li><a href="Tracker.html">Tracker</a></li><li><a href="User.html">User</a></li></ul><h3>Classes</h3><ul><li><a href="AccountsPassword.html">AccountsPassword</a></li><li><a href="Collection.html">Collection</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="DDP.html">DDP</a></li><li><a href="MongoID.ObjectID.html">ObjectID</a></li><li><a href="Tracker.Computation.html">Computation</a></li><li><a href="Tracker.Dependency.html">Dependency</a></li><li><a href="module.html#.exports">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#MongoID">MongoID</a></li><li><a href="global.html#SHA256">SHA256</a></li><li><a href="global.html#close">close</a></li><li><a href="global.html#empty">empty</a></li><li><a href="global.html#getObservers">getObservers</a></li><li><a href="global.html#hasOwn">hasOwn</a></li><li><a href="global.html#hashPassword">hashPassword</a></li><li><a href="global.html#isPlainObject">isPlainObject</a></li><li><a href="global.html#isWindow">isWindow</a></li><li><a href="global.html#localCollections">localCollections</a></li><li><a href="global.html#open">open</a></li><li><a href="global.html#process">process</a></li><li><a href="global.html#push">push</a></li><li><a href="global.html#send">send</a></li><li><a href="global.html#stringify">stringify</a></li><li><a href="global.html#type">type</a></li><li><a href="global.html#uniqueId">uniqueId</a></li><li><a href="global.html#withNoYieldsAllowed">withNoYieldsAllowed</a></li></ul>
229+
</nav>
230+
231+
<br class="clear">
232+
233+
<footer>
234+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Apr 17 2024 08:46:35 GMT+0200 (Central European Summer Time)
235+
</footer>
236+
237+
<script> prettyPrint(); </script>
238+
<script src="scripts/linenumber.js"> </script>
239+
</body>
240+
</html>

0 commit comments

Comments
 (0)