{"_id":"@hyper-fetch/sockets","_rev":"66-1c86c1b63b7a4a0cb1ed4f15aaae2bf7","name":"@hyper-fetch/sockets","dist-tags":{"beta":"5.7.6-beta.1","latest":"9.0.0"},"versions":{"1.0.0":{"name":"@hyper-fetch/sockets","version":"1.0.0","keywords":["websockets","sse","server sent events","heartbeat","reconnect","offline","listener","emitter","socket","events"],"author":{"name":"Maciej Pyrc","email":"m.pyrc@interia.pl"},"license":"Apache-2.0","_id":"@hyper-fetch/sockets@1.0.0","maintainers":[{"name":"prc5","email":"maciekpyrc@gmail.com"}],"homepage":"https://hyperfetch.bettertyped.com/","bugs":{"url":"https://github.com/BetterTyped/hyper-fetch/issues"},"dist":{"shasum":"4e838eacd15b06e49aad894223c029f837e7896e","tarball":"https://registry.npmjs.org/@hyper-fetch/sockets/-/sockets-1.0.0.tgz","fileCount":46,"integrity":"sha512-dkw92f7uYaDpkifqZ5HOAIts0yH30vLMnBHsaDolLFw6CrJ1K03a+XPBwjMOJSXHdeienA/HRqRtTUGFTrRbmQ==","signatures":[{"sig":"MEUCIQC57z4Y6z+Qnc5HyTyB7stanIzXSBO0+sSiS72tVN0jygIgQACTrdscZr9k3645+dFNdEmRc4fUHD97Ea6ERsa9jjY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":154026,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjpxmiACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpzpg/8DCK2Tr0SE+pOVPm658+LD76qw4M0Vhe2LtSfNDZyJKITxcFr\r\nVZIwqyTyE3gIug0QGyyU/5ICk8Y1Xpki7oxBBDpW+pj1aUgZohfRgnTyMHMx\r\nNgmBWG0zfAXzttfoFAbNX/TguBHiaJWDMoW/MC+m4t+13awYbd+rGpVq4IiE\r\nl4pXA86rJzwGaC3CVyRXz9A7NwycKjJyDajZYrWxd0Z7va/Mxn+bUr9TX3sU\r\nGzou5d477HVkKCfu8eqIsFGSsngFvhvJU5i54yW6kxKG4HFDzTTFoRMCQ7c4\r\nu0AOaqWUQi21A4Hh48QudIpzaXR+q11l1Tc0LadzFeFU6vYanq8peYDQtI2Y\r\ndirpmST4topSZZlL6x9z89XHqHO11h5cVxMBVlmEoMaMd8g6YXDiro7QP6m2\r\nUT/CRS3/eubN5Zn0cqIHaaPkA6rPx7dIkKaQxvzJEloc3y2Dt+WHIoYelGEr\r\naBTzLZmDIdgCp2v3cLcMGPLFNSbcOW9Q78Ceqe2sLAPz0vaxBui2hihWglq+\r\naEpSGeC1FRqszxyJ+rQ0Q2AHFVy3nZZjlYDREhsEaiN+21uqmX8ZmDmuXWCr\r\nXnNh6OJGNUKhLQQLMpKHfEOrPe9twhic0yirX1ONAaDMIBV3IxopGF0XyyQG\r\nG3vKjV4j5pl7afq57RXEEufJbInJndnAKNo=\r\n=aH1t\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.cjs.js","types":"dist/index.d.ts","module":"dist/index.esm.js","source":"src/index.ts","gitHead":"387709519f8279ea1368394935d6cc154f95f305","private":false,"scripts":{"lint":"eslint . --ext .js,.jsx,.tsx,.ts --fix","test":"jest --watchAll --maxWorkers=3","build":"yarn clean && node ../../scripts/build.js","clean":"npx rimraf dist","start":"yarn build && npx run-when-changed --watch 'src/**/*.ts' --exec 'yarn build'","format":"prettier --write .","release":"yarn semantic-release --extends ../../release.config.js -t 'hyper-fetch-sockets-v${version}'","postbuild":"ttsc --project tsconfig.json --outDir dist","precommit":"yarn lint-staged","typecheck":"tsc --noEmit --emitDeclarationOnly false","test-pipeline":"jest --watchAll=false --maxWorkers=1 --no-cache","prepublishOnly":"yarn build"},"_npmUser":{"name":"prc5","email":"maciekpyrc@gmail.com"},"repository":{"url":"git+https://github.com/BetterTyped/hyper-fetch.git","type":"git","directory":"packages/sockets"},"_npmVersion":"8.19.3","description":"

\n Real-time data exchange for WebSockets, SSE, and Firebase. Type-safe listeners with automatic reconnection.\n

\n\n

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

\n\n## 📖 About\n\n`@hyper-fetch/sockets` provides a typed abstraction for real-time communication. It wraps WebSockets and Server-Sent\nEvents behind a consistent API with typed listeners and emitters, automatic reconnection, offline queuing, and\nauthentication support.\n\n## 🎯 Key Capabilities\n\n- 🔮 **Type-safe events** — Every listener and emitter is typed end-to-end, no more `JSON.parse` guessing\n- 📡 **WebSocket + SSE, one API** — Switch between protocols without rewriting your event handlers\n- 🔁 **Never lose connection** — Auto-reconnect with exponential backoff handles flaky networks for you\n- 📴 **Offline event queuing** — Events you emit offline are saved and sent when connection returns\n- 🔐 **Auth built in** — Token and session-based authentication flows for socket connections\n- ⚛️ **React hooks included** — `useListener` and `useEmitter` plug real-time data straight into components\n- 🖥️ **SSR safe** — Import in server-rendered apps without breaking hydration\n\n## 🚀 Quick Start\n\n```bash\nnpm install @hyper-fetch/sockets\n```\n\n```ts\nimport { Socket } from \"@hyper-fetch/sockets\";\n\nconst socket = new Socket({ url: \"ws://localhost:3000\" });\n\nconst onMessage = socket.createListener<{ response: { text: string; author: string } }>()({\n endpoint: \"chat-message\",\n});\n\nonMessage.listen({ callback: ({ data }) => console.log(`${data.author}: ${data.text}`) });\n```\n\n## 📚 Documentation\n\n- [Getting Started](https://hyperfetch.bettertyped.com/docs/getting-started/quick-start)\n- [Sockets Overview](https://hyperfetch.bettertyped.com/docs/sockets/overview)\n- [API Reference](https://hyperfetch.bettertyped.com/api/)\n\n## 💡 Examples\n\n### Emitting typed events\n\n```ts\nconst sendMessage = socket.createEmitter<{ payload: { text: string; room: string } }>()({\n endpoint: \"send-message\",\n});\n\nsendMessage.emit({ data: { text: \"Hello!\", room: \"general\" } });\n```\n\n### Listening with React hooks\n\n```tsx\nimport { useListener } from \"@hyper-fetch/react\";\n\nconst ChatMessages = ({ room }: { room: string }) => {\n const { data, connected, timestamp } = useListener(onMessage);\n\n return (\n
\n

Status: {connected ? \"Connected\" : \"Disconnected\"}

\n {data && (\n
\n {data.author}: {data.text}\n {new Date(timestamp).toLocaleTimeString()}\n
\n )}\n
\n );\n};\n```\n\n### Server-Sent Events\n\n```ts\nconst sseSocket = new Socket({ url: \"https://api.example.com/events\" });\n\nconst onUpdate = sseSocket.createListener<{ response: { type: string; payload: unknown } }>()({\n endpoint: \"data-update\",\n});\n\nonUpdate.listen({\n callback: ({ data }) => console.log(`Event: ${data.type}`, data.payload),\n});\n```\n\n## License\n\n[MIT](https://github.com/BetterTyped/hyper-fetch/blob/main/License.md)\n","readmeFilename":"README.md"}