@cumulus/collection-config-store 21.2.0 → 21.3.0
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/.nycrc.json +1 -1
- package/docs/API.md +8 -8
- package/package.json +6 -6
package/.nycrc.json
CHANGED
package/docs/API.md
CHANGED
|
@@ -18,7 +18,7 @@ Utilities for storing and retrieving collection config in S3
|
|
|
18
18
|
### CollectionConfigStore ⏏
|
|
19
19
|
Store and retrieve collection configs in S3
|
|
20
20
|
|
|
21
|
-
**Kind**: Exported class
|
|
21
|
+
**Kind**: Exported class
|
|
22
22
|
<a name="new_module_collection-config-store--CollectionConfigStore_new"></a>
|
|
23
23
|
|
|
24
24
|
#### new CollectionConfigStore(bucket, stackName)
|
|
@@ -30,7 +30,7 @@ Initialize a CollectionConfigStore instance
|
|
|
30
30
|
| bucket | <code>string</code> | the bucket where collection configs are stored |
|
|
31
31
|
| stackName | <code>string</code> | the Cumulus deployment stack name |
|
|
32
32
|
|
|
33
|
-
**Example**
|
|
33
|
+
**Example**
|
|
34
34
|
```js
|
|
35
35
|
const CollectionConfigStore = require('@cumulus/collection-config-store');
|
|
36
36
|
|
|
@@ -44,8 +44,8 @@ const collectionConfigStore = new CollectionConfigStore(
|
|
|
44
44
|
#### collectionConfigStore.get(name, version) ⇒ <code>Promise.<Object></code>
|
|
45
45
|
Fetch a collection config from S3 (or cache if available)
|
|
46
46
|
|
|
47
|
-
**Kind**: instance method of [<code>CollectionConfigStore</code>](#exp_module_collection-config-store--CollectionConfigStore)
|
|
48
|
-
**Returns**: <code>Promise.<Object></code> - the fetched collection config
|
|
47
|
+
**Kind**: instance method of [<code>CollectionConfigStore</code>](#exp_module_collection-config-store--CollectionConfigStore)
|
|
48
|
+
**Returns**: <code>Promise.<Object></code> - the fetched collection config
|
|
49
49
|
|
|
50
50
|
| Param | Type | Description |
|
|
51
51
|
| --- | --- | --- |
|
|
@@ -57,9 +57,9 @@ Fetch a collection config from S3 (or cache if available)
|
|
|
57
57
|
#### collectionConfigStore.put(name, version, config) ⇒ <code>Promise.<null></code>
|
|
58
58
|
Store a collection config to S3
|
|
59
59
|
|
|
60
|
-
**Kind**: instance method of [<code>CollectionConfigStore</code>](#exp_module_collection-config-store--CollectionConfigStore)
|
|
60
|
+
**Kind**: instance method of [<code>CollectionConfigStore</code>](#exp_module_collection-config-store--CollectionConfigStore)
|
|
61
61
|
**Returns**: <code>Promise.<null></code> - resolves when the collection config has been written
|
|
62
|
-
to S3
|
|
62
|
+
to S3
|
|
63
63
|
|
|
64
64
|
| Param | Type | Description |
|
|
65
65
|
| --- | --- | --- |
|
|
@@ -72,9 +72,9 @@ Store a collection config to S3
|
|
|
72
72
|
#### collectionConfigStore.delete(name, version) ⇒ <code>Promise.<null></code>
|
|
73
73
|
Delete a collection config from S3
|
|
74
74
|
|
|
75
|
-
**Kind**: instance method of [<code>CollectionConfigStore</code>](#exp_module_collection-config-store--CollectionConfigStore)
|
|
75
|
+
**Kind**: instance method of [<code>CollectionConfigStore</code>](#exp_module_collection-config-store--CollectionConfigStore)
|
|
76
76
|
**Returns**: <code>Promise.<null></code> - resolves when the collection config has been deleted
|
|
77
|
-
to S3
|
|
77
|
+
to S3
|
|
78
78
|
|
|
79
79
|
| Param | Type | Description |
|
|
80
80
|
| --- | --- | --- |
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cumulus/collection-config-store",
|
|
3
|
-
"version": "21.
|
|
3
|
+
"version": "21.3.0",
|
|
4
4
|
"description": "Utility for persisting collection configuration to S3 and retrieving it",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"CUMULUS",
|
|
7
7
|
"NASA"
|
|
8
8
|
],
|
|
9
9
|
"engines": {
|
|
10
|
-
"node": ">=
|
|
10
|
+
"node": ">=22.21.1"
|
|
11
11
|
},
|
|
12
12
|
"publishConfig": {
|
|
13
13
|
"access": "public"
|
|
@@ -35,9 +35,9 @@
|
|
|
35
35
|
"author": "Cumulus Authors",
|
|
36
36
|
"license": "Apache-2.0",
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@cumulus/aws-client": "21.
|
|
39
|
-
"@cumulus/common": "21.
|
|
40
|
-
"@cumulus/message": "21.
|
|
38
|
+
"@cumulus/aws-client": "21.3.0",
|
|
39
|
+
"@cumulus/common": "21.3.0",
|
|
40
|
+
"@cumulus/message": "21.3.0"
|
|
41
41
|
},
|
|
42
|
-
"gitHead": "
|
|
42
|
+
"gitHead": "9dd4a7d4b888ea713efa87d6086a762262d46dd2"
|
|
43
43
|
}
|