From f28b86e71eacc4b3e9b7ed84df7bbb71f7bf4a68 Mon Sep 17 00:00:00 2001 From: Nick Jennings Date: Sun, 21 Aug 2022 22:47:01 +0200 Subject: [PATCH] coverage baseline --- .github/workflows/compliance.yml | 2 ++ README.md | 6 ++++-- package.json | 3 ++- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/workflows/compliance.yml b/.github/workflows/compliance.yml index 7dec4c1..a68be78 100644 --- a/.github/workflows/compliance.yml +++ b/.github/workflows/compliance.yml @@ -33,6 +33,8 @@ jobs: run: npm run build - name: Test run: npm run test + - name: Coverage + run: npm run coverage integration: runs-on: ubuntu-latest diff --git a/README.md b/README.md index 7f90177..6470da4 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,6 @@ a number of connections in a pool, using them as needed and keeping all aspects of releasing active connections internal to the object, so the user does not need to worry about forgotten connections leaking resources. -**NOTE** Version 2.x is a rewrite and not backward compatible, please re-read the documentation to update your code. - ## Installation ```javascript @@ -117,6 +115,10 @@ lpush(key, value) sendCommand(commandName, [args]) ``` +* **shutdown** +```javascript +shutdown() +``` ## API Documentation node-redis-connection-pool uses jsdoc-to-markdown to generate the [API.md](API.md) from the source code. diff --git a/package.json b/package.json index 1db7073..c5cb3ed 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "redis-connection-pool", - "version": "2.0.4", + "version": "3.0.0", "description": "a redis client connection pool", "license": "MIT", "private": false, @@ -27,6 +27,7 @@ "lint:fix": "npx eslint --fix src/", "lint": "npx eslint src/", "test": "c8 -x src/bootstrap -x \"src/**/*.test.*\" mocha -r ts-node/register src/*.test.ts", + "coverage": "c8 check-coverage --statements 70 --branches 90 --functions 60 --lines 70", "integration": "mocha -r ts-node/register src/index.integration.ts && yarn run build && mocha dist/index.integration.js", "doc": "jsdoc2md --files ./src/index.ts --configure ./jsdoc2md.json > ./API.md" },