{"id":20706264,"url":"https://github.com/schneidmaster/actioncable-modules","last_synced_at":"2025-04-23T02:04:04.427Z","repository":{"id":57172784,"uuid":"62960108","full_name":"schneidmaster/actioncable-modules","owner":"schneidmaster","description":"Fork of ActionCable client patched for proper module support","archived":false,"fork":false,"pushed_at":"2019-03-14T16:45:10.000Z","size":31,"stargazers_count":11,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-23T02:03:52.940Z","etag":null,"topics":["actioncable","rails"],"latest_commit_sha":null,"homepage":null,"language":"CoffeeScript","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/schneidmaster.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-09T17:08:35.000Z","updated_at":"2019-03-14T16:45:12.000Z","dependencies_parsed_at":"2022-08-24T13:31:03.916Z","dependency_job_id":null,"html_url":"https://github.com/schneidmaster/actioncable-modules","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schneidmaster%2Factioncable-modules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schneidmaster%2Factioncable-modules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schneidmaster%2Factioncable-modules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schneidmaster%2Factioncable-modules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/schneidmaster","download_url":"https://codeload.github.com/schneidmaster/actioncable-modules/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250354498,"owners_count":21416752,"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":["actioncable","rails"],"created_at":"2024-11-17T01:22:15.075Z","updated_at":"2025-04-23T02:04:04.404Z","avatar_url":"https://github.com/schneidmaster.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm version](https://badge.fury.io/js/actioncable-modules.svg)](https://badge.fury.io/js/actioncable-modules)\n\n# Deprecated\n\nNew versions of this package will no longer be published as of Rails 6. I recommend switching to the official package, [@rails/actioncable](https://www.npmjs.com/package/@rails/actioncable).\n\n# actioncable-modules\n\nA fork of the [Rails 5 ActionCable](https://github.com/rails/rails/tree/master/actioncable) client code, lightly patched and maintained for proper module support.\n\n## Why?\n\nAs of 5.0.0, the official actioncable npm package was broken outside of browser usage, and the [core team](https://github.com/rails/rails/issues/25649) was unwilling to release a fixed version bump for more than five months (until Rails 5.0.1 was released). This package provided support for webpack/node builds during that timespan, and will ensure modules continue to be properly supported in the future.\n\n## Patches\n\nTo ready the code for modular usage, Sprockets requires have been replaced with module requires and module.exports added to each source file. Additionally, I have made a few light patches to work better with modules; each is labeled with a `# PATCH` comment to make it clear where the code diverts from the official Rails source.\n\n## Versioning\n\nVersioning of this package will match the versioning of the related Rails gem (starting with 5.0.0). Any minor version bumps for project-specific bugs will be hyphenated on the third semver point, e.g. `5.0.0-1`.\n\nNew versions will be published to npm for each new stable version of Rails. Beta and rc versions (tagged `beta` and `rc` respectively) will be published if the corresponding Rails beta/rc contains any changes to the ActionCable frontend code.\n\n## Installation\n\n```\nnpm install actioncable-modules --save\n```\n\n## Usage\n\nSimply require the module. The API matches the official Rails docs.\n\n```javascript\nconst ActionCable = require('actioncable-modules');\n\nlet actionCable = ActionCable.createConsumer(\"ws://cable.example.com\");\nactionCable.subscriptions.create \"AppearanceChannel\", ...\n```\n\nFull documentation can be found [here](https://github.com/rails/rails/tree/master/actioncable).\n\nAdditionally, for debug usage, you can temporarily (or permanently) enable more verbose logging:\n\n```javascript\nconst ActionCable = require('actioncable-modules');\n\nActionCable.debug.start();\n// more verbose logs\n\nActionCable.debug.stop();\n// no more verbose logs\n```\n\n## Contributing\n\n1. Fork it ( https://github.com/schneidmaster/actioncable-modules/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## License\n\nMIT. (The rails source code included in this project is also MIT-licensed.)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschneidmaster%2Factioncable-modules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fschneidmaster%2Factioncable-modules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschneidmaster%2Factioncable-modules/lists"}