1 | # @cumulus/common
|
2 |
|
3 | Common libraries used in Cumulus.
|
4 |
|
5 | ## Usage
|
6 |
|
7 | ```bash
|
8 | npm install @cumulus/common
|
9 | ```
|
10 |
|
11 | ## About Cumulus
|
12 |
|
13 | Cumulus is a cloud-based data ingest, archive, distribution and management prototype for NASA's future Earth science data streams.
|
14 |
|
15 | [Cumulus Documentation](https://nasa.github.io/cumulus)
|
16 |
|
17 | ## General Utilities
|
18 |
|
19 | * [@cumulus/common/aws](./aws.js) - Utilities for working with AWS. For ease of
|
20 | setup, testing, and credential management, code should obtain AWS client
|
21 | objects from helpers in this module.
|
22 | * [@cumulus/common/concurrency](./concurrency.js) - Utilities for writing concurrent code
|
23 | * [@cumulus/common/errors](./errors.js) - Classes for thrown errors
|
24 | * [@cumulus/common/log](./log.js) - muting or potentially shipping logs to
|
25 | alternative locations
|
26 | * [@cumulus/common/string](./docs/API.md#module_string) - Utilities for
|
27 | manipulating strings
|
28 | * [@cumulus/common/test-utils](./test-utils.js) - Utilities for writing tests
|
29 | * [@cumulus/common/URLUtils](./docs/API.md#module_URLUtils) - a collection of
|
30 | utilities for working with URLs
|
31 | * [@cumulus/common/util](./docs/API.md#module_util) - Other misc general
|
32 | utilities
|
33 |
|
34 | ## Contributing
|
35 |
|
36 | To make a contribution, please [see our contributing guidelines](https://github.com/nasa/cumulus/blob/master/CONTRIBUTING.md).
|