Package Exports
- @barchart/common-node-js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@barchart/common-node-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
barchart-common-node-js
Common classes, utilities, and functions for exclusively for Node.js servers
This library can serve as the foundation for Node.js servers.
Features include:
- Several promise-based convenience wrappers for the AWS SDK (including DynamoDB, S3, SES, SNS, SQS)
- Asynchronous Message Bus for Request-Response (with Amazon SQS implementation)
- Asynchronous Message Bus for Request-Response (with Amazon SNS SQS implementation)
- Quick HTTP servers with REST and/or Socket.IO endpoints (using Express)
- Some Utilities for Node.js streams
- More
Documentation
The code is documented with JSDoc. While the output hasn't been committed to source control, you can generate the documentation by using the following commands:
> npm install
> gulp documentDevelopment
Gulp is used to check "linting" and run unit tests, as follows:
> npm install
> gulp lint
> gulp testLicense
This software is provided under the MIT license.