aboutsummaryrefslogtreecommitdiffstats
path: root/actioncable/lib/rails/generators/channel/USAGE
blob: dd109fda80b8b341ea588f57c1b86a8d4d6b715b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
Description:
============
    Stubs out a new cable channel for the server (in Ruby) and client (in CoffeeScript).
    Pass the channel name, either CamelCased or under_scored, and an optional list of channel actions as arguments.

    Note: Turn on the cable connection in app/assets/javascripts/cable.js after generating any channels.

Example:
========
    rails generate channel Chat speak

    creates a Chat channel class and CoffeeScript asset:
        Channel:    app/channels/chat_channel.rb
        Assets:     app/assets/javascripts/channels/chat.coffee