{"id":18157512,"url":"https://github.com/ubermanu/sveltekit-websocket","last_synced_at":"2025-05-06T21:08:26.656Z","repository":{"id":158732925,"uuid":"634184832","full_name":"ubermanu/sveltekit-websocket","owner":"ubermanu","description":"A websocket implementation for SvelteKit","archived":false,"fork":false,"pushed_at":"2025-05-05T09:37:52.000Z","size":210,"stargazers_count":23,"open_issues_count":2,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-06T21:08:21.100Z","etag":null,"topics":["sveltekit","websocket","ws"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ubermanu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-29T10:13:14.000Z","updated_at":"2025-05-05T02:19:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"cadf4922-ddcf-404d-a0f8-423fe4d5ca33","html_url":"https://github.com/ubermanu/sveltekit-websocket","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubermanu%2Fsveltekit-websocket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubermanu%2Fsveltekit-websocket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubermanu%2Fsveltekit-websocket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ubermanu%2Fsveltekit-websocket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ubermanu","download_url":"https://codeload.github.com/ubermanu/sveltekit-websocket/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252769423,"owners_count":21801378,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["sveltekit","websocket","ws"],"created_at":"2024-11-02T06:06:28.720Z","updated_at":"2025-05-06T21:08:26.636Z","avatar_url":"https://github.com/ubermanu.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @ubermanu/sveltekit-websocket\n\nThis is a small websocket plugin for SvelteKit. It uses [ws](https://github.com/websockets/ws) under the hood.\n\n## Install\n\n    pnpm i @ubermanu/sveltekit-websocket -D\n\n## Config\n\nUse the patched `node-adapter` in `svelte.config.js`:\n\n```js\nimport adapter from '@ubermanu/sveltekit-websocket'\n\nconst config = {\n  kit: {\n    adapter: adapter(),\n  },\n}\n\nexport default config\n```\n\nUse the websocket dev server in `vite.config.js`:\n\n```js\nimport { sveltekit } from '@sveltejs/kit/vite'\nimport { websocket } from '@ubermanu/sveltekit-websocket/vite'\nimport { defineConfig } from 'vite'\n\nexport default defineConfig({\n  plugins: [sveltekit(), websocket()],\n})\n```\n\n## Usage\n\nCreate your websocket handler in `src/hooks.server.js`:\n\n```js\n/** @type {import('@ubermanu/sveltekit-websocket').HandleWebsocket} */\nexport function handleWebsocket({ socket }) {\n  socket.on('message', () =\u003e {\n    socket.send('something')\n  })\n}\n```\n\nConnect to the endpoint using any websocket client:\n\n```svelte\n\u003cscript\u003e\n  import { browser } from '$app/environment'\n  import { page } from '$app/state'\n\n  const socket = browser ? new WebSocket(`ws://${page.url.host}`) : null\n\n  let connected = $state(false)\n\n  socket?.addEventListener('open', () =\u003e (connected = true))\n  socket?.addEventListener('close', () =\u003e (connected = false))\n\u003c/script\u003e\n\n\u003cp\u003e\n  Websocket connection status: {connected ? '🟢' : '🔴'}\n\u003c/p\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubermanu%2Fsveltekit-websocket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fubermanu%2Fsveltekit-websocket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fubermanu%2Fsveltekit-websocket/lists"}