aboutsummaryrefslogblamecommitdiffstats
path: root/actioncable/lib/rails/generators/channel/USAGE
blob: 27a934c689fa0c800ec1df765979fe133f673da3 (plain) (tree)
1
2
3
4
5
6

            
                                                                                        
                                                                                                                   
 
                                                                                                           







                                                              
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/javascript/cable.coffee 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/javascript/channels/chat.coffee