{"_id":"@boardgame.io/redis-pubsub","_rev":"3-ee8fb517e30986e6ae54601e64e449b2","name":"@boardgame.io/redis-pubsub","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@boardgame.io/redis-pubsub","version":"0.0.1","keywords":["boardgame.io","redis"],"author":"","license":"MIT","_id":"@boardgame.io/redis-pubsub@0.0.1","maintainers":[{"name":"nicolodavis","email":"nicolodavis@gmail.com"},{"name":"jasonharrison","email":"me@jasonharrison.us"},{"name":"flamecoals","email":"felizardow@gmail.com"},{"name":"delucis","email":"swithinbank@gmail.com"}],"homepage":"https://github.com/boardgameio/bgio-redis-pubsub#readme","bugs":{"url":"https://github.com/boardgameio/bgio-redis-pubsub/issues"},"dist":{"shasum":"6f32425558fc885bd352f22d84376df4d2b2b085","tarball":"https://registry.npmjs.org/@boardgame.io/redis-pubsub/-/redis-pubsub-0.0.1.tgz","fileCount":9,"integrity":"sha512-Io3AG0YIQrulVnx6S2fnDu64BA+dekAWxb/Mnk8Vls5tRPM11rh03wCXmmBxn5uniJxjnTklXSOKGH6+27HOzQ==","signatures":[{"sig":"MEQCIFZR4Gy2FuDo0CFuTckrI7orRcG95VRfg4p7gjbNgIAhAiAo+8AL4LKu+urdKnuC1+Ay4WNa+mw258ujAL2LWLYM+w==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8252,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhGUzyCRA9TVsSAnZWagAAlq4P/1wFrTiTp3rSc5vQmno8\n+KvFkYSRoMBILB89mJMc7J1IW9nlO5A4J5DZ7WSHR6G38tV0gDv6T+swULgC\nmM5ghtSl1ttUzNLtmgv6A3PIcQsXcCHoQiIALfwIO6LMf1kSW3wWpjP1iz9W\n4/Uv0cYr+2A7NLoLx96pgJdssrLsIeXsDhPxnKa4ZRkp9RjUKuO5FZCwVek8\n8cza6SLNVDlvzqMdyKAA359/vZXFhWw73xoyG9hQoBDcKq463xeQY2rxFblX\nzvuqZ9+UqpEstEzgVa2W5RIZ8YF1m+uO5t96nTyNhht19pR3WjGSMzBIS068\nBFPMp4cl+r1CucR42dkobc2KRdSXPn00M/tfYRW5nNp0Mybnx9u5xGurYSdI\nnZPWNXvn6myMxnseoQdlJhJw1mzJi4mOSFJ5XZ1jGD0+GxmuD2C0+ylTSLxY\noX3AA3DmhcQa1uov8H5l8TQG3ZpaRrF1PmHMorfY1DvTvogzXAHELzy44pCm\naiVN5w6sX533JZm14VK/19U9FNR/vVFxHSuRHYVTkKpuZmy/ViUPGxqMdyRo\nYvd/YVnigp5d4Y60lhDNzcWscTMj2fQrsLudZpQk8wbyb0SCE25EuzBC2n3x\nHXVvFZO2NmGO/jwPL6adzoZAcT6vN90QxvohE+I1JcMMfx8y9/9NpFpKUGVT\ncUvr\r\n=pM4S\r\n-----END PGP SIGNATURE-----\r\n"},"jest":{"testMatch":["<rootDir>/src/**/*.test.ts"]},"main":"lib/index.js","types":"lib/index.d.ts","funding":["https://github.com/boardgameio/boardgame.io?sponsor=1",{"url":"https://opencollective.com/boardgameio","type":"opencollective"}],"gitHead":"2fc934590174aa27ed8a7a5bd199fad337d8df3c","private":false,"scripts":{"fix":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json","test":"jest","build":"tsc","prepare":"npm run build","prepublishOnly":"npm test && npm run lint"},"_npmUser":{"name":"flamecoals","email":"felizardow@gmail.com"},"repository":{"url":"git+https://github.com/boardgameio/bgio-redis-pubsub.git","type":"git"},"_npmVersion":"6.14.13","description":"Redis pub/sub adapter for boardgame.io","directories":{},"_nodeVersion":"14.17.3","_hasShrinkwrap":false,"devDependencies":{"jest":"^27.0.6","tslint":"^6.1.3","prettier":"^2.3.2","babel-jest":"^27.0.6","ts-mockito":"^2.6.1","typescript":"^4.3.5","@babel/core":"^7.15.0","@types/jest":"^27.0.1","@types/redis":"^2.8.31","boardgame.io":"^0.47.0","@babel/preset-env":"^7.15.0","@types/koa-router":"^7.4.4","tslint-config-prettier":"^1.18.0","@babel/preset-typescript":"^7.15.0"},"peerDependencies":{"redis":">=3.1.2","boardgame.io":">=0.47.0"},"_npmOperationalInternal":{"tmp":"tmp/redis-pubsub_0.0.1_1629048050512_0.26449048959496224","host":"s3://npm-registry-packages"}}},"time":{"created":"2021-08-15T17:20:50.452Z","modified":"2026-07-02T17:08:06.285Z","0.0.1":"2021-08-15T17:20:50.661Z"},"bugs":{"url":"https://github.com/boardgameio/bgio-redis-pubsub/issues"},"license":"MIT","homepage":"https://github.com/boardgameio/bgio-redis-pubsub#readme","keywords":["boardgame.io","redis"],"repository":{"url":"git+https://github.com/boardgameio/bgio-redis-pubsub.git","type":"git"},"description":"Redis pub/sub adapter for boardgame.io","maintainers":[{"email":"nicolodavis@gmail.com","name":"nicolodavis"},{"email":"swithinbank@gmail.com","name":"delucis"}],"readme":"# @boardgame.io/redis-pubsub\nThis package provides a Redis pub/sub adapter for [boardgame.io](https://boardgame.io/).\n\n## Installation\n\n```sh\nnpm install @boardgame.io/redis-pubsub\n```\n\n## Requirements\n\nRequires `redis` npm library `3.1.2` or greater ([docs](https://github.com/NodeRedis/node-redis)), and `boardgame.io` version `0.47.0` or greater ([docs](https://boardgame.io)). \nUsing a database adaptor (i.e. postgres) that stores and shares the state across servers is also required to properly horizontally scale them.\n\n## Usage\n\n```\nimport { RedisPubSub } from 'bgio-redis-pubsub'\nimport { Server, Origins, SocketIO } from 'boardgame.io/server';\nimport MyGame from './src/MyGame';\nimport redis from 'redis';\nimport { PostgresStore } from 'bgio-postgres';\n\nconst redisConfig = { host: '192.168.8.50' };\nconst pubClient = redis.createClient(redisConfig);\nconst subClient = pubClient.duplicate();\nconst server = Server({\n  games: [MyGame],\n  db: new PostgresStore('vdf@192.168.8.50/vdf'),\n  origins: [Origins.LOCALHOST],\n  transport: new SocketIO({\n    pubSub: new RedisPubSub(pubClient, subClient),\n  }),\n});\nserver.run(8000);\n```\n","readmeFilename":"README.md"}