Merge pull request #237 from arsonik/patch-1

Redis Cluster to be used in types, Dependencies update ...

Author: davidyaha

.eslintignore

@@ -0,0 +1,3 @@
+node_modules
+src/test
+dist

.eslintrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+    root: true,
+    parser: '@typescript-eslint/parser',
+    plugins: [
+        '@typescript-eslint',
+    ],
+    extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+    ],
+};

.gitignore

@@ -4,3 +4,4 @@ dist
 coverage
 typings
 npm-debug.log
+.nyc_output

.mocharc.json

@@ -0,0 +1,6 @@
+{
+  "ui": "bdd",
+  "exit": true,
+  "check-leaks": true,
+  "require": ["ts-node/register"]
+}

.nycrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@istanbuljs/nyc-config-typescript",
+  "all": false,
+  "include": ["src/**"],
+  "exclude": ["src/test/**"],
+  "check-coverage": true
+}

.travis.yml

@@ -7,8 +7,13 @@ cache:
   directories:
     - node_modules
 
+before_install:
+  - docker run -d -p 127.0.0.1:7000:7000 -p 127.0.0.1:7001:7001 -p 127.0.0.1:7002:7002 -p 127.0.0.1:7003:7003 -p 127.0.0.1:7004:7004 -p 127.0.0.1:7005:7005 grokzen/redis-cluster:latest
+
 install:
   - npm install
 
 services:
+  - docker
   - redis-server
+

README.md

@@ -133,6 +133,21 @@ const pubsub = new RedisPubSub({
 });
 ```
 
+**Also works with your Redis Cluster**
+
+```javascript
+import { RedisPubSub } from 'graphql-redis-subscriptions';
+import { Cluster } from 'ioredis';
+
+const cluster = new Cluster(REDIS_NODES); // like: [{host: 'ipOrHost', port: 1234}, ...]
+const pubsub = new RedisPubSub({
+  ...,
+  publisher: cluster,
+  subscriber: cluster
+});
+```
+
+
 You can learn more on the `ioredis` package [here](https://github.com/luin/ioredis).
 
 ## Using a custom reviver
@@ -231,3 +246,16 @@ The subscription string that Redis will receive will be `comments.added.graphql-
 This subscription string is much more specific and means the the filtering required for this type of subscription is not needed anymore.
 This is one step towards lifting the load off of the GraphQL API server regarding subscriptions.
 
+## Tests
+
+### Spin a Redis in docker server and cluster
+Please refer to https://github.com/Grokzen/docker-redis-cluster documentation to start a cluster
+```shell script
+$ docker run --rm -p 6379:6379 redis:alpine
+$ export REDIS_CLUSTER_IP=0.0.0.0; docker run -e "IP=0.0.0.0" --rm -p 7000:7000 -p 7001:7001 -p 7002:7002 -p 7003:7003 -p 7004:7004 -p 7005:7005 grokzen/redis-cluster
+```
+
+### Test
+```shell script
+npm run test
+```