Scripts

Description

To test and build the rethinkdb-job-queue package you need to run scripts. These scripts are managed in the package.json file as npm scripts.

The best source of information about the scripts is to review the scripts section of the package.json file and learn from that. To get you started though, this document lists the common useful scripts below.

If you have docker-compose installed there is a docker-compose.yaml file in the root of the repository you can use to launch an instance of RethinkDB. This is handy for testing purposes.

To use the below commands from the command line, change directory into the location you have rethinkdb-job-queue installed and type the command.

Command Line	Description
npm test	Integration tests
npm run tv	Integration tests with verbose output
npm run lint	JavaScript Standard Style linting
npm run coverage	Produces a coverage report using Istanbul
npm run build	Transpiles the src directory to the dist directory
npm run upgrade	Upgrades the projects dependency packages
docker-compose up	Launches a RethinkDB instance exposing a local port