@cumulus/message 9.2.3 → 9.4.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 (2) hide show
  1. package/README.md +17 -0
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -37,6 +37,10 @@ from a Cumulus message</p>
37
37
  <dt><a href="#exp_module_Collections--exports.constructCollectionId">exports.constructCollectionId(name, version)</a> ⇒ <code>string</code> ⏏</dt>
38
38
  <dd><p>Returns the collection ID.</p>
39
39
  </dd>
40
+ <dt><a href="#deconstructCollectionId">deconstructCollectionId(collectionId)</a> ⇒ <code>Object</code></dt>
41
+ <dd><p>Returns the name and version of a collection based on
42
+ the collectionId used in elasticsearch indexing</p>
43
+ </dd>
40
44
  <dt><a href="#exp_module_Collections--exports.getCollectionNameAndVersionFromMessage">exports.getCollectionNameAndVersionFromMessage(message)</a> ⇒ <code>CollectionInfo</code> | <code>undefined</code> ⏏</dt>
41
45
  <dd><p>Get collection name and version from execution message.</p>
42
46
  </dd>
@@ -395,6 +399,19 @@ of S3 remote message
395
399
  | stepMessage | <code>CMAMessage</code> | Message for the step |
396
400
  | stepName | <code>string</code> | Name of the step |
397
401
 
402
+ <a name="deconstructCollectionId"></a>
403
+
404
+ ### deconstructCollectionId(collectionId) ⇒ <code>Object</code>
405
+ Returns the name and version of a collection based on
406
+ the collectionId used in elasticsearch indexing
407
+
408
+ **Kind**: global function
409
+ **Returns**: <code>Object</code> - name and version as object
410
+
411
+ | Param | Type | Description |
412
+ | --- | --- | --- |
413
+ | collectionId | <code>string</code> | collectionId used in elasticsearch index |
414
+
398
415
 
399
416
  ## About Cumulus
400
417
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cumulus/message",
3
- "version": "9.2.3",
3
+ "version": "9.4.1",
4
4
  "description": "Utilities for building and parsing Cumulus messages",
5
5
  "keywords": [
6
6
  "GIBS",
@@ -38,11 +38,11 @@
38
38
  "author": "Cumulus Authors",
39
39
  "license": "Apache-2.0",
40
40
  "dependencies": {
41
- "@cumulus/aws-client": "9.2.3",
42
- "@cumulus/common": "9.2.3",
43
- "@cumulus/errors": "9.2.3",
44
- "@cumulus/logger": "9.2.3",
45
- "@cumulus/types": "9.2.3",
41
+ "@cumulus/aws-client": "9.4.1",
42
+ "@cumulus/common": "9.4.1",
43
+ "@cumulus/errors": "9.4.1",
44
+ "@cumulus/logger": "9.4.1",
45
+ "@cumulus/types": "9.4.1",
46
46
  "jsonpath-plus": "^3.0.0",
47
47
  "lodash": "^4.17.20",
48
48
  "uuid": "^8.2.0"
@@ -50,5 +50,5 @@
50
50
  "devDependencies": {
51
51
  "@types/uuid": "^8.0.0"
52
52
  },
53
- "gitHead": "91c94e8972edd3f35b6a1f7e22f81ab3f3f1c3ee"
53
+ "gitHead": "fce4415918c43a6a14d46ac7d9572f5a97a98a45"
54
54
  }