handy-redis - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

dist/src/index.d.ts

 import { ClientOpts, RedisClient } from "redis";
 import { IHandyRedis } from "./generated/interface";
-export * from "redis";
 export * from "./generated/interface";
@@ -5,0 +4,0 @@ export interface ICreateHandyClient {

dist/src/index.js

 "use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
 Object.defineProperty(exports, "__esModule", { value: true });
 const redis_1 = require("redis");
 const client_1 = require("./generated/client");
-__export(require("redis"));
 exports.createHandyClient = (...args) => {
@@ -10,0 +6,0 @@ if (args.length === 1 && typeof args[0].zscan === "function") {

package.json

 {
   "name": "handy-redis",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A wrapper around node_redis with Promise and TypeScript support.",
@@ -12,7 +12,9 @@ "main": "dist/src/index.js",
     "clean": "shx rm -rf {dist,src/generated}",
-    "precompile": "ts-node scripts/generate-client",
     "compile": "tsc --project .",
+    "prebuild": "ts-node scripts/generate-client",
+    "build": "tsc --project .",
     "lint": "tslint **/*.ts",
-    "pretest": "npm run compile",
-    "test": "ava dist/test **/__tests__/*.js",
+    "pretest": "npm run build",
+    "test": "npm run test:unit",
+    "test:unit": "ava dist/test **/__tests__/*.js",
     "posttest": "npm run lint",
@@ -19,0 +21,0 @@ "semantic-release": "semantic-release pre && npm publish && semantic-release post",

README.md

 # handy-redis
-A wrapper around node_redis with Promise and TypeScript support.
+A wrapper around [node_redis](https://npmjs.com/package/redis) with Promise and TypeScript support.
 
-[![Build Status](https://travis-ci.org/mmkal/hodor.svg?branch=master)](https://travis-ci.org/mmkal/handy-redis)
+[![Build Status](https://travis-ci.org/mmkal/handy-redis.svg?branch=master)](https://travis-ci.org/mmkal/handy-redis)
+
+## Why
+
+[node_redis](https://npmjs.com/package/redis) doesn't support Promises out-of-the-box - you have to use bluebird's `promisifyAll`, which has the side effect of removing all TypeScript/intellisense support from the package.
+
+This package exclusively uses Promises, and the TypeScript types are generated from the official redis documentation and examples, so it's much easier to know what parameters a command expects.
+
+## Using
+
+```cli
+npm install --save handy-redis
+```
+
+ES6/TypeScript:
+```JavaScript
+import { createHandyClient } from 'handy-redis';
+
+(async function() {
+    const client = createHandyClient();
+    // or, call createHandyClient(opts) using opts for https://npmjs.com/package/redis
+    // or, call createHandyClient(oldClient) where oldClient is an existing node_redis client.
+
+    await client.set('foo', 'bar');
+    const foo = await client.get('foo');
+    console.log(foo);
+})();
+```
+
+Vanilla JS:
+```JavaScript
+const handyRedis = require('handy-redis');
+
+const client = handyRedis.createHandyClient();
+
+client
+    .set('foo', 'bar')
+    .then(() => client.get('foo'))
+    .then(foo => console.log(foo));
+```
+
+The package is published with TypeScript types, with the redis documentation and response type attached to each command:
+![](./docs/intellisense.png)
+
+## Development
+
+Most of the package is generated by running sample commands from the redis documentation repo.
+
+```cli
+git clone https://github.com/mmkal/handy-redis --recursive
+npm install
+npm test
+```
+
+`npm test` triggers `npm run build` before running the tests - and the `build` script generates the client before using TypeScript to compile it.
+
+If you cloned without `--recursive` you'll need to run `git submodule update --init` to get the redis-doc repo locally.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

648862

increased by0.73%

Number of package files

13

increased by44.44%

Lines of code

17741

increased by0.1%

Number of lines in readme file

61

increased by1120%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes