@cobaltio/cobalt-js 2.1.2 → 2.1.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.
- package/README.md +21 -3
- package/cobalt.js +6 -1
- package/docs.md +16 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,8 +20,11 @@ yarn add @cobaltio/cobalt-js
|
|
|
20
20
|
### Include
|
|
21
21
|
|
|
22
22
|
#### Browser
|
|
23
|
-
```
|
|
24
|
-
|
|
23
|
+
```html
|
|
24
|
+
<!-- import the latest version -->
|
|
25
|
+
<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js"></script>
|
|
26
|
+
<!-- import a specific version -->
|
|
27
|
+
<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@2"></script>
|
|
25
28
|
```
|
|
26
29
|
|
|
27
30
|
#### Node
|
|
@@ -65,6 +68,9 @@ cobalt.token = "COBALT_SESSION_TOKEN";
|
|
|
65
68
|
<dt><a href="#Label">Label</a> : <code>Object</code></dt>
|
|
66
69
|
<dd><p>Field Mapping Label</p>
|
|
67
70
|
</dd>
|
|
71
|
+
<dt><a href="#DynamicField">DynamicField</a> : <code>Object</code></dt>
|
|
72
|
+
<dd><p>Field Mapping Label</p>
|
|
73
|
+
</dd>
|
|
68
74
|
<dt><a href="#DynamicFields">DynamicFields</a> : <code>Object</code></dt>
|
|
69
75
|
<dd><p>The dynamic fields payload.</p>
|
|
70
76
|
</dd>
|
|
@@ -281,6 +287,18 @@ Field Mapping Label
|
|
|
281
287
|
| name | <code>string</code> | The Label name. |
|
|
282
288
|
| value | <code>string</code> \| <code>number</code> \| <code>boolean</code> | The Label value. |
|
|
283
289
|
|
|
290
|
+
<a name="DynamicField"></a>
|
|
291
|
+
|
|
292
|
+
## DynamicField : <code>Object</code>
|
|
293
|
+
Field Mapping Label
|
|
294
|
+
|
|
295
|
+
**Kind**: global typedef
|
|
296
|
+
**Properties**
|
|
297
|
+
|
|
298
|
+
| Name | Type | Description |
|
|
299
|
+
| --- | --- | --- |
|
|
300
|
+
| fields | [<code>Array.<Label></code>](#Label) | The Label name. |
|
|
301
|
+
|
|
284
302
|
<a name="DynamicFields"></a>
|
|
285
303
|
|
|
286
304
|
## DynamicFields : <code>Object</code>
|
|
@@ -291,7 +309,7 @@ The dynamic fields payload.
|
|
|
291
309
|
|
|
292
310
|
| Name | Type | Description |
|
|
293
311
|
| --- | --- | --- |
|
|
294
|
-
| map_fields_object | <code>Object.<string,
|
|
312
|
+
| map_fields_object | <code>Object.<string, DynamicField></code> | desc. |
|
|
295
313
|
|
|
296
314
|
<a name="SavedConfig"></a>
|
|
297
315
|
|
package/cobalt.js
CHANGED
|
@@ -192,9 +192,14 @@ class Cobalt {
|
|
|
192
192
|
* @property {string | number | boolean} value The Label value.
|
|
193
193
|
*/
|
|
194
194
|
|
|
195
|
+
/**
|
|
196
|
+
* @typedef {Object} DynamicField Field Mapping Label
|
|
197
|
+
* @property {Label[]} fields The Label name.
|
|
198
|
+
*/
|
|
199
|
+
|
|
195
200
|
/**
|
|
196
201
|
* @typedef {Object} DynamicFields The dynamic fields payload.
|
|
197
|
-
* @property {Object.<string,
|
|
202
|
+
* @property {Object.<string, DynamicField>} map_fields_object desc.
|
|
198
203
|
*/
|
|
199
204
|
|
|
200
205
|
/**
|
package/docs.md
CHANGED
|
@@ -15,6 +15,9 @@
|
|
|
15
15
|
<dt><a href="#Label">Label</a> : <code>Object</code></dt>
|
|
16
16
|
<dd><p>Field Mapping Label</p>
|
|
17
17
|
</dd>
|
|
18
|
+
<dt><a href="#DynamicField">DynamicField</a> : <code>Object</code></dt>
|
|
19
|
+
<dd><p>Field Mapping Label</p>
|
|
20
|
+
</dd>
|
|
18
21
|
<dt><a href="#DynamicFields">DynamicFields</a> : <code>Object</code></dt>
|
|
19
22
|
<dd><p>The dynamic fields payload.</p>
|
|
20
23
|
</dd>
|
|
@@ -231,6 +234,18 @@ Field Mapping Label
|
|
|
231
234
|
| name | <code>string</code> | The Label name. |
|
|
232
235
|
| value | <code>string</code> \| <code>number</code> \| <code>boolean</code> | The Label value. |
|
|
233
236
|
|
|
237
|
+
<a name="DynamicField"></a>
|
|
238
|
+
|
|
239
|
+
## DynamicField : <code>Object</code>
|
|
240
|
+
Field Mapping Label
|
|
241
|
+
|
|
242
|
+
**Kind**: global typedef
|
|
243
|
+
**Properties**
|
|
244
|
+
|
|
245
|
+
| Name | Type | Description |
|
|
246
|
+
| --- | --- | --- |
|
|
247
|
+
| fields | [<code>Array.<Label></code>](#Label) | The Label name. |
|
|
248
|
+
|
|
234
249
|
<a name="DynamicFields"></a>
|
|
235
250
|
|
|
236
251
|
## DynamicFields : <code>Object</code>
|
|
@@ -241,7 +256,7 @@ The dynamic fields payload.
|
|
|
241
256
|
|
|
242
257
|
| Name | Type | Description |
|
|
243
258
|
| --- | --- | --- |
|
|
244
|
-
| map_fields_object | <code>Object.<string,
|
|
259
|
+
| map_fields_object | <code>Object.<string, DynamicField></code> | desc. |
|
|
245
260
|
|
|
246
261
|
<a name="SavedConfig"></a>
|
|
247
262
|
|