{"_id":"@aersoftware/react-use-action-cable","_rev":"9-31d0d6c4ec2a7e40dd28624f2c1372c2","time":{"created":"2022-02-07T14:02:21.263Z","0.0.9":"2022-02-07T13:44:48.041Z","modified":"2023-05-31T13:48:28.029Z","1.0.0":"2022-02-07T14:02:21.465Z","1.0.1":"2022-02-14T10:08:13.166Z","1.0.2":"2023-05-31T12:52:54.842Z","1.0.3":"2023-05-31T13:01:51.074Z","1.0.4":"2023-05-31T13:48:27.879Z"},"name":"@aersoftware/react-use-action-cable","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.0":{"name":"@aersoftware/react-use-action-cable","version":"1.0.0","description":"Hooks to easily use Rails Action Cable in your React (Native) application","main":"dist/index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","prebuild":"npm i","build":"babel src --out-dir dist"},"author":{"name":"Jacco van der Plaat","email":"jacco.vanderplaat@aer.nl","url":"aer.nl"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/aersoftware/react-use-action-cable.git"},"peerDependencies":{"react":"^17.0.1"},"dependencies":{"@rails/actioncable":"^7.0.0"},"devDependencies":{"@babel/core":"^7.16.7","@babel/cli":"^7.16.7","copyfiles":"^2.4.1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"gitHead":"605a0279f66fe685d4352f2747a3b71b79e4dce4","bugs":{"url":"https://github.com/aersoftware/react-use-action-cable/issues"},"homepage":"https://github.com/aersoftware/react-use-action-cable#readme","_id":"@aersoftware/react-use-action-cable@1.0.0","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-dCCZTEp27WJC55Y3je4woawqh8MhLpWIupgDRBYnA4zGFHQlASil2wOiiVwd5ERrhMcXTz36cBUQNvJy5E2K4g==","shasum":"7da8fdf8d7f86faac2e54e905c3093e8271ade78","tarball":"https://registry.npmjs.org/@aersoftware/react-use-action-cable/-/react-use-action-cable-1.0.0.tgz","fileCount":3,"unpackedSize":7177,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJiASZtCRA9TVsSAnZWagAA7IQP/RUDdLzqo58gE8voX5FO\ng0vi0qWNcPopbrXB7ceQVtHISnQRLDIFJn/7TWgOi7L8oAdZRlJew+L5lqbO\nlaCbmXMyF8yy4TM5PrxnqGU1lksL0qtn1r7/I5K9HB7kGdNaxkaWsC8I7HGG\nxwXG27L8mdMl/Qn8RTb7k1h48kp0DlLQE4Mj29+5hnkifNU2Bj3UBtCQbV18\nUJ+ntrvL1Cx9J2ZP4ukZYKmwor5W0oCWFS3Psfi0R3lnwo/TTxYJQwMhpBJk\nMk9hnvbfrymBXWyoupSkBfcanNQwqQGNgEEvdsgX6AnZdENxASUt/dLx94+R\njjE1tqdEorTsSQv9Xfhic+nl7Uhkks4p83lJbkd9mrq/LepgwuhUWCiax53B\ndGIfr1TQHb5x/XK1R9Utaay0V+Dn6Rirp/gF5yzo5io58/CQuE0L8IZSY7L0\nzGXzXZ0nqtfjoCQXR0rKlEozWk3PZhmIC5Znxssi354JAUcnRvtLLFLOC4Fk\n8yF1dWVfiwtwOBZjF8w8ey2rRvHd8l6bkeCzSkcaPsAXuOTqtEd/gV7FvZtI\nXKZbXedxSEHMYJee0admy3fda3SS1UL5F4WCFTFPRM2ljlT1WJkgrPJcvlau\nRWwyYVqcb5I8mmhBPrgEdusgl0BfDl7odUJlVZqefOK4xXRiWjaaDpIcWuNU\nxMFt\r\n=I9pm\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBBeYWl2u8kgPWO7aLOoJstJj2W3EiGaVoGNcr1CO//eAiEAp87+535c8AsobuKriUDlpE4/a+Ee4qz/kh6nTXN8meY="}]},"_npmUser":{"name":"jaccovdp_aer","email":"jacco.vanderplaat@aer.nl"},"directories":{},"maintainers":[{"name":"jaccovdp_aer","email":"jacco.vanderplaat@aer.nl"},{"name":"reinvanmeeteren","email":"rein.vanmeeteren@aer.nl"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-use-action-cable_1.0.0_1644242541348_0.4327742072390346"},"_hasShrinkwrap":false},"1.0.1":{"name":"@aersoftware/react-use-action-cable","version":"1.0.1","description":"Hooks to easily use Rails Action Cable in your React (Native) application","main":"dist/index.js","scripts":{"test":"npx jest src/index.spec.js --coverage","prebuild":"npm i","build":"babel src --out-dir dist"},"author":{"name":"Jacco van der Plaat","email":"jacco.vanderplaat@aer.nl","url":"aer.nl"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/aersoftware/react-use-action-cable.git"},"peerDependencies":{"react":"^17.0.1"},"dependencies":{"@rails/actioncable":"^7.0.0"},"devDependencies":{"@babel/cli":"^7.16.7","@babel/core":"^7.16.7","@babel/preset-env":"^7.16.11","@babel/preset-react":"^7.16.7","@testing-library/react":"^12.1.2","copyfiles":"^2.4.1","jest":"^27.5.1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"keywords":["react","hooks","rails","cable","actioncable","socket","websocket"],"gitHead":"0c9cf401911071e6f573153467cbdc40bcd3e07e","bugs":{"url":"https://github.com/aersoftware/react-use-action-cable/issues"},"homepage":"https://github.com/aersoftware/react-use-action-cable#readme","_id":"@aersoftware/react-use-action-cable@1.0.1","_nodeVersion":"16.13.2","_npmVersion":"8.1.2","dist":{"integrity":"sha512-RtbxqCg9Bc5cgeOHgwvQq4lTf26dv8DJBlxJ+Lv8+a7NFfdJQ+PQJEwanxJzjpgnxK4TbHFkenTUh9Z4J2pk2A==","shasum":"fbc5b564de5a75b756acad74f1c2fa4c3030427c","tarball":"https://registry.npmjs.org/@aersoftware/react-use-action-cable/-/react-use-action-cable-1.0.1.tgz","fileCount":4,"unpackedSize":21473,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJiCioNCRA9TVsSAnZWagAAUgIP/0L+onpbUjLaMMzjEV/B\no80XkxpdFf8wP5xWWgQTuNHYWR/PLWa993SLnZW1n28yykHTbM1E95K5DtSX\n2XWmLpKIurKaFJdtI0cspJnBf1QZcdAxiS6cwEQ48mDozjy1WjgtFFhAykle\nlSQg036I/pQAXEcofNdgHUCJRLuw4dCMl3x0Zu8gXw1JMMMBjgL4JZ7uNqN2\nsAhqZ9wLYwHwTmucyOPX1lJmKuDdunvMiAojgFTeN0xDbnry/BA97o125OrC\n8rzrSQ/+h0yLPkWp8eeiWRPVFQSYBObXqK85wVWNfpqgFgFmR0zJnnQrYRjd\nb+deA8w9Ka0qThE6W5eiN+Vgh68pKvl3vqB7AQ0x4gVcWEHTBvrwWYhW/Opo\ndUdoMasvitYU9ngWv41bEfJ6PhGtU8xMX0zgvhnM936tsOlX52TJhLYpQ+6o\n9qDHz3n1bjIoDIZxQr6zIiEEC9U8JyXBlDLFaRjtT/Ge8tmkG9d4BfUgQzue\nGyTNLoAtlkNAW32PhJ/RKeiVSCOEprufrM6XnsI/Da9s0o+3ZO2c8574pxiB\nnzYWS6aUAkAl9DtVeivXuoaWxEXLW6Z5kAUoEaUZmh2DZpuhNVNa9CDnh6n/\nJnSDA9jgbRWLPnmgi6rdfhH752xeCGX4whSZX08wmlM2FaYuP4kPqLiCEqRN\nCa/s\r\n=0b8T\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCc/ArY9DDe+zja/Xu3+GcnzCvKt7+hBra/EcJwc9F4zgIhAOw4vaINADQyGNf9OEFSeq5aEQVax0DxK3xDs1IV4d8o"}]},"_npmUser":{"name":"jaccovdp_aer","email":"jacco.vanderplaat@aer.nl"},"directories":{},"maintainers":[{"name":"jaccovdp_aer","email":"jacco.vanderplaat@aer.nl"},{"name":"reinvanmeeteren","email":"rein.vanmeeteren@aer.nl"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-use-action-cable_1.0.1_1644833293023_0.4967903494873829"},"_hasShrinkwrap":false},"1.0.2":{"name":"@aersoftware/react-use-action-cable","version":"1.0.2","description":"Hooks to easily use Rails Action Cable in your React (Native) application","main":"dist/index.js","scripts":{"test":"npx jest src/index.spec.js --coverage","prebuild":"npm i","build":"babel src --out-dir dist"},"author":{"name":"Jacco van der Plaat","email":"jacco.vanderplaat@aer.nl","url":"aer.nl"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/aersoftware/react-use-action-cable.git"},"peerDependencies":{"react":"^17.0.1 || ^18.2.0"},"dependencies":{"@rails/actioncable":"^7.0.0"},"devDependencies":{"@babel/cli":"^7.16.7","@babel/core":"^7.16.7","@babel/preset-env":"^7.16.11","@babel/preset-react":"^7.16.7","@testing-library/react":"^14.0.0","copyfiles":"^2.4.1","jest":"^27.5.1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"keywords":["react","hooks","rails","cable","actioncable","socket","websocket"],"gitHead":"3a68c3b3556ff944995c0fb35926b3ab0af3607f","bugs":{"url":"https://github.com/aersoftware/react-use-action-cable/issues"},"homepage":"https://github.com/aersoftware/react-use-action-cable#readme","_id":"@aersoftware/react-use-action-cable@1.0.2","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-ILczd4Qier6tS6C+mI4Q7+hBFo8PsJtIc3Nwqkr3jyoa/zkGPenqL424No3n/3DMy3Hng7Oni4tP/c3yLL6Dig==","shasum":"782b3a479a6504256b737d130e82dee9ae31fb4d","tarball":"https://registry.npmjs.org/@aersoftware/react-use-action-cable/-/react-use-action-cable-1.0.2.tgz","fileCount":4,"unpackedSize":22783,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDOnWqfreijSMEN6KZoMWvR329eJeLaE0LpTQVRCK0I+wIgFjMWH2l4ehkR+eO/383QYuFCfQ+5fSrqGii0mgrhnHA="}]},"_npmUser":{"name":"jaccovdp_aer","email":"jacco.vanderplaat@aer.nl"},"directories":{},"maintainers":[{"name":"jaccovdp_aer","email":"jacco.vanderplaat@aer.nl"},{"name":"reinvanmeeteren","email":"rein.vanmeeteren@aer.nl"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-use-action-cable_1.0.2_1685537574693_0.9559970187673335"},"_hasShrinkwrap":false},"1.0.4":{"name":"@aersoftware/react-use-action-cable","version":"1.0.4","description":"Hooks to easily use Rails Action Cable in your React (Native) application","main":"dist/index.js","scripts":{"test":"npx jest src/index.spec.js --coverage","prebuild":"npm i","build":"babel src --out-dir dist"},"author":{"name":"Jacco van der Plaat","email":"jacco.vanderplaat@aer.nl","url":"aer.nl"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/aersoftware/react-use-action-cable.git"},"peerDependencies":{"react":"^17 || ^18"},"dependencies":{"@rails/actioncable":"^7.0.0"},"devDependencies":{"@babel/cli":"^7.16.7","@babel/core":"^7.16.7","@babel/preset-env":"^7.16.11","@babel/preset-react":"^7.16.7","@testing-library/react":"^14.0.0","copyfiles":"^2.4.1","jest":"^27.5.1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"keywords":["react","hooks","rails","cable","actioncable","socket","websocket"],"gitHead":"7f96096dc921d3201b923b25de74b93bfabcfe6e","bugs":{"url":"https://github.com/aersoftware/react-use-action-cable/issues"},"homepage":"https://github.com/aersoftware/react-use-action-cable#readme","_id":"@aersoftware/react-use-action-cable@1.0.4","_nodeVersion":"16.13.2","_npmVersion":"8.9.0","dist":{"integrity":"sha512-8SLATfwTtHJreMrEb7EmNr5mQAlx/2UW2+pOOfCBbH2mES0TNoHahO7zKdxx5UZYGoZREjdBtjII4/5rw8w9IQ==","shasum":"8468621ef84f56d6db2359dc04cd688874ec8d57","tarball":"https://registry.npmjs.org/@aersoftware/react-use-action-cable/-/react-use-action-cable-1.0.4.tgz","fileCount":4,"unpackedSize":22775,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICdpr+xDzPuKNNco53eUPXhFtZ1CRmsU1aWEpfRGcua0AiAQKigTeK8akzWKuHhk7CAMv6wMWyod23/Yu7GPIZ9AcQ=="}]},"_npmUser":{"name":"reinvanmeeteren","email":"rein.vanmeeteren@aer.nl"},"directories":{},"maintainers":[{"name":"jaccovdp_aer","email":"jacco.vanderplaat@aer.nl"},{"name":"reinvanmeeteren","email":"rein.vanmeeteren@aer.nl"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-use-action-cable_1.0.4_1685540907727_0.6174448019024572"},"_hasShrinkwrap":false}},"maintainers":[{"name":"jaccovdp_aer","email":"jacco.vanderplaat@aer.nl"},{"name":"reinvanmeeteren","email":"rein.vanmeeteren@aer.nl"}],"description":"Hooks to easily use Rails Action Cable in your React (Native) application","homepage":"https://github.com/aersoftware/react-use-action-cable#readme","repository":{"type":"git","url":"git+https://github.com/aersoftware/react-use-action-cable.git"},"author":{"name":"Jacco van der Plaat","email":"jacco.vanderplaat@aer.nl","url":"aer.nl"},"bugs":{"url":"https://github.com/aersoftware/react-use-action-cable/issues"},"license":"MIT","readme":"# React Use Action Cable\nHooks to use Rails Action Cable in your React (Native) application.\n\n## Installation\n```bash\nnpm install @aersoftware/react-use-action-cable --save\n```\n\n## Usage\n\n### Connecting to a websocket\nTo connect to an Action Cable, simply call the useActionCable hook with the URL you wish to connect to. If you want to be able to use this Action Cable throughout your application consider implementing it in a [context](https://reactjs.org/docs/context.html).\n```js\nimport React, { useEffect } from 'react';\nimport { useActionCable, useChannel } from '@aersoftware/react-use-action-cable';\n\nexport default function index() {\n  const { actionCable } = useActionCable('ws://localhost:3000/cable');\n}\n```\n\n### Subscribe to a channel\nProvide the useChannel hook with the previously created `actionCable`. You then get access to the (un)subscribe and send functions. In the example below we immediately subscribe to the channel 'ChannelName' on the first render.\n```js\n...\n  const { subscribe, unsubscribe, send } = useChannel(actionCable)\n\n  useEffect(() => {\n    subscribe({\n      channel: 'ChannelName',\n      param2: '...',\n      param3: '...'\n    }, {\n      received: (data) => console.log(data),\n      // Custom callbacks can be added for 'initialized', 'connected', and 'disconnected' \n    })\n    return () => {\n      unsubscribe()\n    }\n  }, [])\n...\n```\n\n### Sending data\nTo send data to the channel that we are subscribe to we can use the `send` function as below.\n```js\nsend({\n  action: 'ping',\n  payload: {}, // Optional\n  useQueue: true // Optional, default: false\n})\n```\n\nWhen setting useQueue to `true` the message will be added to a queue and will be sent as soon as possible. That is, immediately when the websocket is connected. If the websocket is not connected at the time `send()` is called it will be sent as soon as the websocket reconnects.","readmeFilename":"README.md","keywords":["react","hooks","rails","cable","actioncable","socket","websocket"]}