@qikdev/sdk 1.0.2 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/README.md +1 -1
  2. package/dist/access.html +16371 -0
  3. package/dist/api.html +1503 -0
  4. package/dist/auth.html +8455 -0
  5. package/dist/cache.html +1135 -0
  6. package/dist/content.html +10067 -0
  7. package/dist/files.html +3415 -0
  8. package/dist/filter.html +4973 -0
  9. package/dist/geo.html +3851 -0
  10. package/dist/global.html +328 -0
  11. package/dist/index.html +96 -0
  12. package/dist/main.js +2 -3
  13. package/dist/module-QikStorage-CookieStorageAdapter.html +1177 -0
  14. package/dist/module-QikStorage-LocalStorageAdapter.html +329 -0
  15. package/dist/module-QikStorage-StorageAdapter.html +3457 -0
  16. package/dist/module-QikStorage.html +1445 -0
  17. package/dist/qik.access.js.html +904 -0
  18. package/dist/qik.api.js.html +409 -0
  19. package/dist/{docs/qik.auth.js.html → qik.auth.js.html} +142 -104
  20. package/dist/qik.cache.js.html +125 -0
  21. package/dist/qik.content.js.html +967 -0
  22. package/dist/qik.core.js.html +322 -0
  23. package/dist/qik.files.js.html +249 -0
  24. package/dist/{docs/qik.filter.js.html → qik.filter.js.html} +2 -2
  25. package/dist/qik.geo.js.html +963 -0
  26. package/dist/qik.socket.js.html +451 -0
  27. package/dist/qik.storage.js.html +375 -0
  28. package/dist/qik.system.js.html +117 -0
  29. package/dist/qik.utils.js.html +1542 -0
  30. package/dist/socket.html +2975 -0
  31. package/dist/{docs/styles → styles}/jsdoc.css +2 -2
  32. package/dist/system.html +523 -0
  33. package/package.json +2 -2
  34. package/src/api/qik.socket.js +18 -12
  35. package/src/version.js +1 -1
  36. package/dist/docs/access.html +0 -3826
  37. package/dist/docs/api.html +0 -1356
  38. package/dist/docs/auth.html +0 -2180
  39. package/dist/docs/cache.html +0 -351
  40. package/dist/docs/content.html +0 -2560
  41. package/dist/docs/files.html +0 -779
  42. package/dist/docs/filter.html +0 -1355
  43. package/dist/docs/index.html +0 -96
  44. package/dist/docs/qik.access.js.html +0 -790
  45. package/dist/docs/qik.api.js.html +0 -511
  46. package/dist/docs/qik.cache.js.html +0 -131
  47. package/dist/docs/qik.content.js.html +0 -918
  48. package/dist/docs/qik.core.js.html +0 -301
  49. package/dist/docs/qik.files.js.html +0 -219
  50. package/dist/docs/qik.socket.js.html +0 -416
  51. package/dist/docs/qik.system.js.html +0 -117
  52. package/dist/docs/qik.utils.js.html +0 -1467
  53. package/dist/docs/socket.html +0 -810
  54. package/dist/docs/system.html +0 -197
  55. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.eot +0 -0
  56. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.ttf +0 -0
  57. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.woff +0 -0
  58. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Bold.woff2 +0 -0
  59. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.eot +0 -0
  60. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.ttf +0 -0
  61. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.woff +0 -0
  62. /package/dist/{docs/fonts → fonts}/Montserrat/Montserrat-Regular.woff2 +0 -0
  63. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  64. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
  65. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  66. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  67. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  68. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  69. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
  70. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  71. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  72. /package/dist/{docs/fonts → fonts}/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  73. /package/dist/{docs/scripts → scripts}/collapse.js +0 -0
  74. /package/dist/{docs/scripts → scripts}/linenumber.js +0 -0
  75. /package/dist/{docs/scripts → scripts}/nav.js +0 -0
  76. /package/dist/{docs/scripts → scripts}/polyfill.js +0 -0
  77. /package/dist/{docs/scripts → scripts}/prettify/Apache-License-2.0.txt +0 -0
  78. /package/dist/{docs/scripts → scripts}/prettify/lang-css.js +0 -0
  79. /package/dist/{docs/scripts → scripts}/prettify/prettify.js +0 -0
  80. /package/dist/{docs/scripts → scripts}/search.js +0 -0
  81. /package/dist/{docs/styles → styles}/prettify.css +0 -0
package/dist/docs/files.html DELETED
@@ -1,779 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
-
5
- <meta charset="utf-8">
6
- <title>files - Documentation</title>
7
-
8
-
9
- <script src="scripts/prettify/prettify.js"></script>
10
- <script src="scripts/prettify/lang-css.js"></script>
11
- <!--[if lt IE 9]>
12
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
- <![endif]-->
14
- <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
- <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
- <script src="scripts/nav.js" defer></script>
17
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
18
- </head>
19
- <body>
20
-
21
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
22
- <label for="nav-trigger" class="navicon-button x">
23
- <div class="navicon"></div>
24
- </label>
25
-
26
- <label for="nav-trigger" class="overlay"></label>
27
-
28
- <nav >
29
-
30
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="access.html">access</a><ul class='methods'><li data-type='method'><a href="access.html#.actionableScopes">actionableScopes</a></li><li data-type='method'><a href="access.html#.allPermissions">allPermissions</a></li><li data-type='method'><a href="access.html#.allPermissionTypes">allPermissionTypes</a></li><li data-type='method'><a href="access.html#.allUserScopes">allUserScopes</a></li><li data-type='method'><a href="access.html#.canCreate">canCreate</a></li><li data-type='method'><a href="access.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="access.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="access.html#.canEraseItem">canEraseItem</a></li><li data-type='method'><a href="access.html#.canKnowOf">canKnowOf</a></li><li data-type='method'><a href="access.html#.canListItem">canListItem</a></li><li data-type='method'><a href="access.html#.canRestoreItem">canRestoreItem</a></li><li data-type='method'><a href="access.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="access.html#.checkActionAccess">checkActionAccess</a></li><li data-type='method'><a href="access.html#.getAllDescendants">getAllDescendants</a></li><li data-type='method'><a href="access.html#.has">has</a></li><li data-type='method'><a href="access.html#.hashPermissions">hashPermissions</a></li><li data-type='method'><a href="access.html#.isAdministrator">isAdministrator</a></li><li data-type='method'><a href="access.html#.isOwner">isOwner</a></li></ul></li><li><a href="api.html">api</a><ul class='methods'><li data-type='method'><a href="api.html#.delete">delete</a></li><li data-type='method'><a href="api.html#.generateEndpointURL">generateEndpointURL</a></li><li data-type='method'><a href="api.html#.get">get</a></li><li data-type='method'><a href="api.html#.patch">patch</a></li><li data-type='method'><a href="api.html#.post">post</a></li><li data-type='method'><a href="api.html#.put">put</a></li></ul></li><li><a href="auth.html">auth</a><ul class='methods'><li data-type='method'><a href="auth.html#.changeOrganisation">changeOrganisation</a></li><li data-type='method'><a href="auth.html#.ensureValidToken">ensureValidToken</a></li><li data-type='method'><a href="auth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="auth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="auth.html#.impersonate">impersonate</a></li><li data-type='method'><a href="auth.html#.login">login</a></li><li data-type='method'><a href="auth.html#.logout">logout</a></li><li data-type='method'><a href="auth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="auth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="auth.html#.set">set</a></li><li data-type='method'><a href="auth.html#.sync">sync</a></li><li data-type='method'><a href="auth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li><a href="cache.html">cache</a><ul class='methods'><li data-type='method'><a href="cache.html#.get">get</a></li><li data-type='method'><a href="cache.html#.reset">reset</a></li></ul></li><li><a href="content.html">content</a><ul class='methods'><li data-type='method'><a href="content.html#.create">create</a></li><li data-type='method'><a href="content.html#.delete">delete</a></li><li data-type='method'><a href="content.html#.get">get</a></li><li data-type='method'><a href="content.html#.getFromSlug">getFromSlug</a></li><li data-type='method'><a href="content.html#.glossary">glossary</a></li><li data-type='method'><a href="content.html#.list">list</a></li><li data-type='method'><a href="content.html#.patch">patch</a></li><li data-type='method'><a href="content.html#.restore">restore</a></li><li data-type='method'><a href="content.html#.scopeGlossary">scopeGlossary</a></li><li data-type='method'><a href="content.html#.update">update</a></li><li data-type='method'><a href="content.html#.validateField">validateField</a></li><li data-type='method'><a href="content.html#.variables">variables</a></li></ul></li><li><a href="files.html">files</a><ul class='methods'><li data-type='method'><a href="files.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="files.html#.filesize">filesize</a></li><li data-type='method'><a href="files.html#.getBinaryTypeFromMime">getBinaryTypeFromMime</a></li><li data-type='method'><a href="files.html#.mediaUrl">mediaUrl</a></li></ul></li><li><a href="filter.html">filter</a><ul class='methods'><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterKeys">activeFilterKeys</a></li><li data-type='method'><a href="filter.html#.activeFilterOperators">activeFilterOperators</a></li><li data-type='method'><a href="filter.html#.activeFilters">activeFilters</a></li><li data-type='method'><a href="filter.html#.activeFilterValues">activeFilterValues</a></li><li data-type='method'><a href="filter.html#.filterChangeString">filterChangeString</a></li><li data-type='method'><a href="filter.html#.isValidFilter">isValidFilter</a></li></ul></li><li><a href="socket.html">socket</a><ul class='methods'><li data-type='method'><a href="socket.html#.channel">channel</a></li><li data-type='method'><a href="socket.html#.close">close</a></li><li data-type='method'><a href="socket.html#.connect">connect</a></li><li data-type='method'><a href="socket.html#.reconnect">reconnect</a></li><li data-type='method'><a href="socket.html#.subscribe">subscribe</a></li><li data-type='method'><a href="socket.html#.unsubscribe">unsubscribe</a></li></ul></li><li><a href="system.html">system</a><ul class='methods'><li data-type='method'><a href="system.html#.countries">countries</a></li></ul></li></ul>
31
- </nav>
32
-
33
- <div id="main">
34
-
35
- <h1 class="page-title">files</h1>
36
-
37
-
38
-
39
-
40
-
41
-
42
-
43
- <section>
44
-
45
- <header>
46
-
47
- <h2>
48
- files
49
- </h2>
50
-
51
-
52
- </header>
53
-
54
- <article>
55
-
56
-
57
-
58
-
59
-
60
-
61
-
62
-
63
-
64
-
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
- <h3 class="subsection-title">Methods</h3>
73
-
74
-
75
-
76
-
77
-
78
-
79
- <h4 class="name" id=".downloadUrl"><span class="type-signature">(static) </span>downloadUrl<span class="signature">(type, id, params)</span><span class="type-signature"></span></h4>
80
-
81
-
82
-
83
-
84
-
85
-
86
- <dl class="details">
87
-
88
-
89
- <dt class="tag-source">Source:</dt>
90
- <dd class="tag-source"><ul class="dummy"><li>
91
- <a href="qik.files.js.html">qik.files.js</a>, <a href="qik.files.js.html#line33">line 33</a>
92
- </li></ul></dd>
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
- </dl>
125
-
126
-
127
-
128
-
129
-
130
- <div class="description usertext">
131
- Get a valid download url for a specified record
132
- </div>
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
- <h5>Example</h5>
143
-
144
- <pre class="prettyprint"><code>const url = sdk.files.downloadUrl('image', '61eca4746971e75c1fc670cf', {w:100, h:100});
145
- // https://api.qik.dev/image/61eca4746971e75c1fc670cf?w=100&amp;h=100&amp;download=true
146
-
147
- const url = sdk.files.downloadUrl('image', {_id:'61eca4746971e75c1fc670cf'...}, {f:'png'});
148
- // https://api.qik.dev/image/61eca4746971e75c1fc670cf?w=100&amp;h=100&amp;download=true</code></pre>
149
-
150
-
151
-
152
-
153
- <h5>Parameters:</h5>
154
-
155
-
156
- <table class="params">
157
- <thead>
158
- <tr>
159
-
160
- <th>Name</th>
161
-
162
-
163
- <th>Type</th>
164
-
165
-
166
-
167
-
168
-
169
- <th class="last">Description</th>
170
- </tr>
171
- </thead>
172
-
173
- <tbody>
174
-
175
-
176
- <tr>
177
-
178
- <td class="name"><code>type</code></td>
179
-
180
-
181
- <td class="type">
182
-
183
-
184
- <span class="param-type">String</span>
185
-
186
-
187
-
188
- </td>
189
-
190
-
191
-
192
-
193
-
194
- <td class="description last">The type or definition of the item we want to generate the url for</td>
195
- </tr>
196
-
197
-
198
-
199
- <tr>
200
-
201
- <td class="name"><code>id</code></td>
202
-
203
-
204
- <td class="type">
205
-
206
-
207
- <span class="param-type">Object</span>
208
- |
209
-
210
- <span class="param-type">String</span>
211
-
212
-
213
-
214
- </td>
215
-
216
-
217
-
218
-
219
-
220
- <td class="description last">The id or object with an _id property that we want to generate the url for</td>
221
- </tr>
222
-
223
-
224
-
225
- <tr>
226
-
227
- <td class="name"><code>params</code></td>
228
-
229
-
230
- <td class="type">
231
-
232
-
233
- <span class="param-type">Object</span>
234
-
235
-
236
-
237
- </td>
238
-
239
-
240
-
241
-
242
-
243
- <td class="description last">Additional parameters and options for the url</td>
244
- </tr>
245
-
246
-
247
- </tbody>
248
- </table>
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
- <h4 class="name" id=".filesize"><span class="type-signature">(static) </span>filesize<span class="signature">(bytes)</span><span class="type-signature"></span></h4>
274
-
275
-
276
-
277
-
278
-
279
-
280
- <dl class="details">
281
-
282
-
283
- <dt class="tag-source">Source:</dt>
284
- <dd class="tag-source"><ul class="dummy"><li>
285
- <a href="qik.files.js.html">qik.files.js</a>, <a href="qik.files.js.html#line73">line 73</a>
286
- </li></ul></dd>
287
-
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
- </dl>
319
-
320
-
321
-
322
-
323
-
324
- <div class="description usertext">
325
- Convert bytes to a human readable file size
326
- </div>
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
- <h5>Example</h5>
337
-
338
- <pre class="prettyprint"><code>const size = sdk.files.filesize(1500);
339
- // 1.5kb</code></pre>
340
-
341
-
342
-
343
-
344
- <h5>Parameters:</h5>
345
-
346
-
347
- <table class="params">
348
- <thead>
349
- <tr>
350
-
351
- <th>Name</th>
352
-
353
-
354
- <th>Type</th>
355
-
356
-
357
-
358
-
359
-
360
- <th class="last">Description</th>
361
- </tr>
362
- </thead>
363
-
364
- <tbody>
365
-
366
-
367
- <tr>
368
-
369
- <td class="name"><code>bytes</code></td>
370
-
371
-
372
- <td class="type">
373
-
374
-
375
- <span class="param-type">Integer</span>
376
-
377
-
378
-
379
- </td>
380
-
381
-
382
-
383
-
384
-
385
- <td class="description last">The number of bytes</td>
386
- </tr>
387
-
388
-
389
- </tbody>
390
- </table>
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
- <h4 class="name" id=".getBinaryTypeFromMime"><span class="type-signature">(static) </span>getBinaryTypeFromMime<span class="signature">(fileMime)</span><span class="type-signature"></span></h4>
416
-
417
-
418
-
419
-
420
-
421
-
422
- <dl class="details">
423
-
424
-
425
- <dt class="tag-source">Source:</dt>
426
- <dd class="tag-source"><ul class="dummy"><li>
427
- <a href="qik.files.js.html">qik.files.js</a>, <a href="qik.files.js.html#line96">line 96</a>
428
- </li></ul></dd>
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
-
438
-
439
-
440
-
441
-
442
-
443
-
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
-
452
-
453
-
454
-
455
-
456
-
457
-
458
-
459
-
460
- </dl>
461
-
462
-
463
-
464
-
465
-
466
- <div class="description usertext">
467
- Get the basic primitive type of a file from it's mime type value
468
- </div>
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
- <h5>Example</h5>
479
-
480
- <pre class="prettyprint"><code>const type = sdk.files.getBinaryTypeFromMime('image/svg+xml');
481
- // 'image'
482
-
483
- const type = sdk.files.getBinaryTypeFromMime('video/webm');
484
- // 'video'</code></pre>
485
-
486
-
487
-
488
-
489
- <h5>Parameters:</h5>
490
-
491
-
492
- <table class="params">
493
- <thead>
494
- <tr>
495
-
496
- <th>Name</th>
497
-
498
-
499
- <th>Type</th>
500
-
501
-
502
-
503
-
504
-
505
- <th class="last">Description</th>
506
- </tr>
507
- </thead>
508
-
509
- <tbody>
510
-
511
-
512
- <tr>
513
-
514
- <td class="name"><code>fileMime</code></td>
515
-
516
-
517
- <td class="type">
518
-
519
-
520
- <span class="param-type">String</span>
521
-
522
-
523
-
524
- </td>
525
-
526
-
527
-
528
-
529
-
530
- <td class="description last">The mime type of the file</td>
531
- </tr>
532
-
533
-
534
- </tbody>
535
- </table>
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
-
550
-
551
-
552
-
553
-
554
-
555
-
556
-
557
-
558
-
559
-
560
- <h4 class="name" id=".mediaUrl"><span class="type-signature">(static) </span>mediaUrl<span class="signature">(type, id, params)</span><span class="type-signature"></span></h4>
561
-
562
-
563
-
564
-
565
-
566
-
567
- <dl class="details">
568
-
569
-
570
- <dt class="tag-source">Source:</dt>
571
- <dd class="tag-source"><ul class="dummy"><li>
572
- <a href="qik.files.js.html">qik.files.js</a>, <a href="qik.files.js.html#line55">line 55</a>
573
- </li></ul></dd>
574
-
575
-
576
-
577
-
578
-
579
-
580
-
581
-
582
-
583
-
584
-
585
-
586
-
587
-
588
-
589
-
590
-
591
-
592
-
593
-
594
-
595
-
596
-
597
-
598
-
599
-
600
-
601
-
602
-
603
-
604
-
605
- </dl>
606
-
607
-
608
-
609
-
610
-
611
- <div class="description usertext">
612
- Get a valid media url for a specified image, video or audio item
613
- </div>
614
-
615
-
616
-
617
-
618
-
619
-
620
-
621
-
622
-
623
- <h5>Example</h5>
624
-
625
- <pre class="prettyprint"><code>const url = sdk.files.mediaUrl('image', '61eca4746971e75c1fc670cf', {w:100, h:100});
626
- // https://api.qik.dev/image/61eca4746971e75c1fc670cf?w=100&amp;h=100&amp;download=true
627
-
628
- const url = sdk.files.mediaUrl('image', {_id:'61eca4746971e75c1fc670cf'...}, {f:'png'});
629
- // https://api.qik.dev/image/61eca4746971e75c1fc670cf?w=100&amp;h=100&amp;download=true</code></pre>
630
-
631
-
632
-
633
-
634
- <h5>Parameters:</h5>
635
-
636
-
637
- <table class="params">
638
- <thead>
639
- <tr>
640
-
641
- <th>Name</th>
642
-
643
-
644
- <th>Type</th>
645
-
646
-
647
-
648
-
649
-
650
- <th class="last">Description</th>
651
- </tr>
652
- </thead>
653
-
654
- <tbody>
655
-
656
-
657
- <tr>
658
-
659
- <td class="name"><code>type</code></td>
660
-
661
-
662
- <td class="type">
663
-
664
-
665
- <span class="param-type">String</span>
666
-
667
-
668
-
669
- </td>
670
-
671
-
672
-
673
-
674
-
675
- <td class="description last">The type or definition of the item we want to generate the url for</td>
676
- </tr>
677
-
678
-
679
-
680
- <tr>
681
-
682
- <td class="name"><code>id</code></td>
683
-
684
-
685
- <td class="type">
686
-
687
-
688
- <span class="param-type">Object</span>
689
- |
690
-
691
- <span class="param-type">String</span>
692
-
693
-
694
-
695
- </td>
696
-
697
-
698
-
699
-
700
-
701
- <td class="description last">The id or object with an _id property that we want to generate the url for</td>
702
- </tr>
703
-
704
-
705
-
706
- <tr>
707
-
708
- <td class="name"><code>params</code></td>
709
-
710
-
711
- <td class="type">
712
-
713
-
714
- <span class="param-type">Object</span>
715
-
716
-
717
-
718
- </td>
719
-
720
-
721
-
722
-
723
-
724
- <td class="description last">Additional parameters and options for the url</td>
725
- </tr>
726
-
727
-
728
- </tbody>
729
- </table>
730
-
731
-
732
-
733
-
734
-
735
-
736
-
737
-
738
-
739
-
740
-
741
-
742
-
743
-
744
-
745
-
746
-
747
-
748
-
749
-
750
-
751
-
752
-
753
-
754
-
755
- </article>
756
-
757
- </section>
758
-
759
-
760
-
761
-
762
-
763
-
764
- </div>
765
-
766
- <br class="clear">
767
-
768
- <footer>
769
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Thu Sep 28 2023 07:24:39 GMT+1000 (Australian Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
770
- </footer>
771
-
772
- <script>prettyPrint();</script>
773
- <script src="scripts/polyfill.js"></script>
774
- <script src="scripts/linenumber.js"></script>
775
-
776
-
777
-
778
- </body>
779
- </html>