Cloud CARL Shared Library

Typescript-NodeJS library that provides and integrated data access layer, authentication, authorization, and logging, eliminating the need for an additional service and overhead. Changes and revisions can be tracked here.

Usage

npm install -g yarn # Setup Yarn Package manager globally

yarn # Setup dependencies and package installations

yarn test # Executes unit tests build using Jest

yarn build # Builds the library dist folder including maps, declarations, and documentation

Features

• Tests, coverage and interactive watch mode using Jest
• Prettier and TSLint for code formatting and consistency.
• Docs automatic generation and deployment to gh-pages, using TypeDoc
• Automatic types (*.d.ts) file generation

NPM scripts

• npm t: Run test suite
• npm start: Runs npm run build in watch mode
• npm run test:watch: Run test suite in interactive watch mode
• npm run test:prod: Run linting and generate coverage
• npm run build: Generage bundles and typings, create docs
• npm run lint: Lints code