@cobaltio/cobalt-js 0.0.1

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 (54) hide show
  1. package/.github/workflows/npm-publish.yml +36 -0
  2. package/LICENSE +21 -0
  3. package/README.md +10 -0
  4. package/cobalt.js +91 -0
  5. package/cobalt.min.js +1 -0
  6. package/docs/Cobalt.html +686 -0
  7. package/docs/cobalt.js.html +142 -0
  8. package/docs/css/bootstrap.min.css +6 -0
  9. package/docs/css/prism.css +138 -0
  10. package/docs/css/prism.min.css +1 -0
  11. package/docs/css/template.min.css +1 -0
  12. package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
  13. package/docs/fonts/OpenSans-Bold-webfont.svg +1830 -0
  14. package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
  15. package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  16. package/docs/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  17. package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  18. package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
  19. package/docs/fonts/OpenSans-Italic-webfont.svg +1830 -0
  20. package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
  21. package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
  22. package/docs/fonts/OpenSans-Light-webfont.svg +1831 -0
  23. package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
  24. package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  25. package/docs/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  26. package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  27. package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
  28. package/docs/fonts/OpenSans-Regular-webfont.svg +1831 -0
  29. package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
  30. package/docs/fonts/glyphicons-halflings-regular.eot +0 -0
  31. package/docs/fonts/glyphicons-halflings-regular.svg +288 -0
  32. package/docs/fonts/glyphicons-halflings-regular.ttf +0 -0
  33. package/docs/fonts/glyphicons-halflings-regular.woff +0 -0
  34. package/docs/fonts/glyphicons-halflings-regular.woff2 +0 -0
  35. package/docs/global.html +662 -0
  36. package/docs/index.html +74 -0
  37. package/docs/js/bootstrap.min.js +7 -0
  38. package/docs/js/clipboard.min.js +7 -0
  39. package/docs/js/jquery.min.js +2 -0
  40. package/docs/js/lunr-data.js +923 -0
  41. package/docs/js/lunr-data.json +923 -0
  42. package/docs/js/lunr.min.js +6 -0
  43. package/docs/js/prism.js +869 -0
  44. package/docs/js/prism.min.js +1 -0
  45. package/docs/js/template.min.js +1 -0
  46. package/docs/list_class.html +128 -0
  47. package/docs/scripts/linenumber.js +25 -0
  48. package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
  49. package/docs/scripts/prettify/lang-css.js +2 -0
  50. package/docs/scripts/prettify/prettify.js +28 -0
  51. package/docs/styles/jsdoc-default.css +358 -0
  52. package/docs/styles/prettify-jsdoc.css +111 -0
  53. package/docs/styles/prettify-tomorrow.css +132 -0
  54. package/package.json +38 -0
@@ -0,0 +1,686 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Class: Cobalt</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: Cobalt</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+
29
+ <header>
30
+
31
+ <h2><span class="attribs"><span class="type-signature"></span></span>Cobalt<span class="signature">(options)</span><span class="type-signature"></span></h2>
32
+
33
+ <div class="class-description">Cobalt Frontend SDK</div>
34
+
35
+
36
+ </header>
37
+
38
+ <article>
39
+ <div class="container-overview">
40
+
41
+
42
+
43
+
44
+ <h2>Constructor</h2>
45
+
46
+
47
+
48
+ <h4 class="name" id="Cobalt"><span class="type-signature"></span>new Cobalt<span class="signature">(options)</span><span class="type-signature"></span></h4>
49
+
50
+
51
+
52
+
53
+
54
+
55
+ <div class="description">
56
+ Cobalt Frontend SDK
57
+ </div>
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+ <h5>Parameters:</h5>
68
+
69
+
70
+ <table class="params">
71
+ <thead>
72
+ <tr>
73
+
74
+ <th>Name</th>
75
+
76
+
77
+ <th>Type</th>
78
+
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>options</code></td>
93
+
94
+
95
+ <td class="type">
96
+
97
+
98
+ <span class="param-type">object</span>
99
+
100
+
101
+
102
+ </td>
103
+
104
+
105
+
106
+
107
+
108
+ <td class="description last">The options to configure the Cobalt SDK.
109
+ <h6>Properties</h6>
110
+
111
+
112
+ <table class="params">
113
+ <thead>
114
+ <tr>
115
+
116
+ <th>Name</th>
117
+
118
+
119
+ <th>Type</th>
120
+
121
+
122
+ <th>Attributes</th>
123
+
124
+
125
+
126
+ <th>Default</th>
127
+
128
+
129
+ <th class="last">Description</th>
130
+ </tr>
131
+ </thead>
132
+
133
+ <tbody>
134
+
135
+
136
+ <tr>
137
+
138
+ <td class="name"><code>baseUrl</code></td>
139
+
140
+
141
+ <td class="type">
142
+
143
+
144
+ <span class="param-type">string</span>
145
+
146
+
147
+
148
+ </td>
149
+
150
+
151
+ <td class="attributes">
152
+
153
+ &lt;optional><br>
154
+
155
+
156
+
157
+
158
+
159
+ </td>
160
+
161
+
162
+
163
+ <td class="default">
164
+
165
+ https://api.gocobalt.io
166
+
167
+ </td>
168
+
169
+
170
+ <td class="description last">The base URL of your Cobalt API.</td>
171
+ </tr>
172
+
173
+
174
+ </tbody>
175
+ </table>
176
+
177
+ </td>
178
+ </tr>
179
+
180
+
181
+ </tbody>
182
+ </table>
183
+
184
+
185
+
186
+
187
+
188
+
189
+ <dl class="details">
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+ <dt class="tag-source">Source:</dt>
217
+ <dd class="tag-source"><ul class="dummy"><li>
218
+ <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line4">line 4</a>
219
+ </li></ul></dd>
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+ </dl>
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+ </div>
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+ <h3 class="subsection-title">Members</h3>
265
+
266
+
267
+
268
+ <h4 class="name" id="baseUrl"><span class="type-signature"></span>baseUrl<span class="type-signature"></span></h4>
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+ <dl class="details">
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+ <dt class="tag-source">Source:</dt>
307
+ <dd class="tag-source"><ul class="dummy"><li>
308
+ <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line32">line 32</a>
309
+ </li></ul></dd>
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+ </dl>
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+ <h4 class="name" id="token"><span class="type-signature"></span>token<span class="type-signature"></span></h4>
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+ <dl class="details">
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+ <dt class="tag-source">Source:</dt>
365
+ <dd class="tag-source"><ul class="dummy"><li>
366
+ <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line18">line 18</a>
367
+ </li></ul></dd>
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+ </dl>
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+ <h4 class="name" id="token"><span class="type-signature"></span>token<span class="type-signature"></span></h4>
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+ <dl class="details">
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+ <dt class="tag-source">Source:</dt>
423
+ <dd class="tag-source"><ul class="dummy"><li>
424
+ <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line25">line 25</a>
425
+ </li></ul></dd>
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+ </dl>
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+ <h3 class="subsection-title">Methods</h3>
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+ <h4 class="name" id="installTemplate"><span class="type-signature">(async) </span>installTemplate<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#Workflow">Workflow</a>>}</span></h4>
453
+
454
+
455
+
456
+
457
+
458
+
459
+ <div class="description">
460
+ Install the given template.
461
+ </div>
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+ <dl class="details">
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+
502
+ <dt class="tag-source">Source:</dt>
503
+ <dd class="tag-source"><ul class="dummy"><li>
504
+ <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line62">line 62</a>
505
+ </li></ul></dd>
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+ </dl>
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+ <h5>Returns:</h5>
530
+
531
+
532
+
533
+
534
+ <dl>
535
+ <dt>
536
+ Type
537
+ </dt>
538
+ <dd>
539
+
540
+ <span class="param-type">Promise.&lt;<a href="global.html#Workflow">Workflow</a>></span>
541
+
542
+
543
+ </dd>
544
+ </dl>
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+ <h4 class="name" id="saveNode"><span class="type-signature">(async) </span>saveNode<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#Workflow">Workflow</a>>}</span></h4>
559
+
560
+
561
+
562
+
563
+
564
+
565
+ <div class="description">
566
+ Install the given template.
567
+ </div>
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+
579
+
580
+
581
+ <dl class="details">
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+ <dt class="tag-source">Source:</dt>
609
+ <dd class="tag-source"><ul class="dummy"><li>
610
+ <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line77">line 77</a>
611
+ </li></ul></dd>
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+ </dl>
620
+
621
+
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+ <h5>Returns:</h5>
636
+
637
+
638
+
639
+
640
+ <dl>
641
+ <dt>
642
+ Type
643
+ </dt>
644
+ <dd>
645
+
646
+ <span class="param-type">Promise.&lt;<a href="global.html#Workflow">Workflow</a>></span>
647
+
648
+
649
+ </dd>
650
+ </dl>
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+
662
+
663
+
664
+ </article>
665
+
666
+ </section>
667
+
668
+
669
+
670
+
671
+ </div>
672
+
673
+ <nav>
674
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Cobalt.html">Cobalt</a></li></ul><h3><a href="global.html">Global</a></h3>
675
+ </nav>
676
+
677
+ <br class="clear">
678
+
679
+ <footer>
680
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Sep 05 2022 15:43:26 GMT+0530 (India Standard Time)
681
+ </footer>
682
+
683
+ <script> prettyPrint(); </script>
684
+ <script src="scripts/linenumber.js"> </script>
685
+ </body>
686
+ </html>