Add documentation about Action Cable npm package #24991
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
r? @jeremy |
| @@ -460,6 +460,28 @@ with all the popular application servers -- Unicorn, Puma and Passenger. | |||
| Action Cable does not work with WEBrick, because WEBrick does not support the | |||
| Rack socket hijacking API. | |||
|
|
|||
| ## npm usage | |||
|
|
|||
| In addition to being available through the `actioncable` gem, Action Cable's frontend JS assets are also bundled in an officially supported npm | |||
maclover7
force-pushed
the
actioncable-npm-docs
branch
from
96c79b2
to
82b7037
Compare
|
sorry for the delay @jeremy, updated 👍 |
|
|
||
| In addition to being available through the `actioncable` gem, Action Cable's | ||
| frontend JS assets are also bundled in an officially supported npm module, | ||
| intended for usage in standalone frontends that communicate with a Rails application. |
maclover7
force-pushed
the
actioncable-npm-docs
branch
from
82b7037
to
d4fbb56
Compare
|
updated 👍 |
| ```javascript | ||
| ActionCable = require('actioncable') | ||
|
|
||
| cable = ActionCable.createConsumer('wss://RAILS-API-PATH.com/cable') |
Sorry, forgot to include in my main PR :( [ci skip] [Jon Moss, Zach Schneider]
maclover7
force-pushed
the
actioncable-npm-docs
branch
from
d4fbb56
to
1713075
Compare
|
👍 we should push for global variables rather than instantiating consumers all over the place ;) |
|
@maclover7 ideally one will instantiate and export them. There is no "global" per say in npm App, and its relative. |
|
👍 yep, this is just meant to get people started |
|
Getting this in for the release, since related changes are already in as part of #24991. |
eileencodes
pushed a commit
that referenced
this pull request
Jun 30, 2016
Add documentation about Action Cable npm package
eileencodes
pushed a commit
that referenced
this pull request
Jun 30, 2016
Add documentation about Action Cable npm package
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sorry, forgot to include in my main PR :(
[ci skip]
Jon Moss, Zach Schneider
cc @jeremy @javan