{"id":20051628,"url":"https://github.com/ring-clojure/ring-websocket-transit","last_synced_at":"2025-04-13T22:11:12.933Z","repository":{"id":202649174,"uuid":"707805629","full_name":"ring-clojure/ring-websocket-transit","owner":"ring-clojure","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-30T18:04:10.000Z","size":15,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-27T12:33:12.836Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ring-clojure.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-10-20T17:44:03.000Z","updated_at":"2025-01-20T11:16:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"d1150977-f7f5-416f-b114-1d3598fabc01","html_url":"https://github.com/ring-clojure/ring-websocket-transit","commit_stats":null,"previous_names":["ring-clojure/ring-websocket-transit"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ring-clojure%2Fring-websocket-transit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ring-clojure%2Fring-websocket-transit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ring-clojure%2Fring-websocket-transit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ring-clojure%2Fring-websocket-transit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ring-clojure","download_url":"https://codeload.github.com/ring-clojure/ring-websocket-transit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788925,"owners_count":21161727,"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":[],"created_at":"2024-11-13T12:05:01.509Z","updated_at":"2025-04-13T22:11:12.911Z","avatar_url":"https://github.com/ring-clojure.png","language":"Clojure","readme":"# Ring-WebSocket-Transit [![Build Status](https://github.com/ring-clojure/ring-websocket-transit/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/ring-clojure/ring-websocket-transit/actions/workflows/test.yml)\n\n\nA Clojure library for using the [Transit][] data format over [Ring's][]\nWebSocket API (currently in beta testing).\n\n[transit]: https://github.com/cognitect/transit-format\n[ring's]: https://github.com/ring-clojure/ring\n\n## Installation\n\nAdd the following dependency to your deps.edn file:\n\n    org.ring-clojure/ring-websocket-transit {:mvn/version \"0.1.0\"}\n\nOr to your Leiningen project file:\n\n    [org.ring-clojure/ring-websocket-transit \"0.1.0\"]\n\n## Usage\n\nThe `wrap-websocket-transit` middleware function converts incoming and\noutgoing WebSocket text messages to and from the Transit data format.\n\nFor example:\n\n```clojure\n(require '[ring.websocket :as ws]\n         '[ring.websocket.transit :as wst])\n\n(def handler\n  (wst/wrap-websocket-transit\n   (fn [_request]\n     {::ws/listener\n      {:on-message\n       (fn [socket message]\n         (ws/send socket (update message :counter inc)))}})))\n```\n\nInstead of receiving a text message via the `on-message` listener event,\na data structure decoded from Transit formatting is supplied instead.\nThe socket argument is also wrapped, such that sending a data structure\nautomatically encodes it.\n\nThis also works with libraries like [Ring-WebSocket-Async][]:\n\n[ring-websocket-async]: https://github.com/ring-clojure/ring-websocket-async\n\n```clojure\n(require '[clojure.core.async :as a :refer [\u003c! \u003e!]]\n         '[ring.websocket.async :as wsa])\n\n(def handler-async\n  (wst/wrap-websocket-transit\n    (fn [_request]\n      (wsa/go-websocket [in out]\n        (loop\n          (when-let [message (\u003c! in)]\n            (\u003e! out (update message :counter inc))\n            (recur)))))))\n```\n\n## License\n\nCopyright © 2023 James Reeves\n\nReleased under the MIT license.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fring-clojure%2Fring-websocket-transit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fring-clojure%2Fring-websocket-transit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fring-clojure%2Fring-websocket-transit/lists"}