mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Add documentation for the mount method in ActionDispatch's Mapper
This commit is contained in:
parent
b591989b5f
commit
b235519777
1 changed files with 17 additions and 0 deletions
|
@ -262,6 +262,23 @@ module ActionDispatch
|
|||
self
|
||||
end
|
||||
|
||||
# Mount a Rack-based application to be used within the application.
|
||||
#
|
||||
# mount SomeRackApp, :at => "some_route"
|
||||
#
|
||||
# Alternatively:
|
||||
#
|
||||
# mount(SomeRackApp => "some_route")
|
||||
#
|
||||
# All mounted applications come with routing helpers to access them.
|
||||
# These are named after the class specified, so for the above example
|
||||
# the helper is either +some_rack_app_path+ or +some_rack_app_url+.
|
||||
# To customize this helper's name, use the +:as+ option:
|
||||
#
|
||||
# mount(SomeRackApp => "some_route", :as => "exciting")
|
||||
#
|
||||
# This will generate the +exciting_path+ and +exciting_url+ helpers
|
||||
# which can be used to navigate to this mounted app.
|
||||
def mount(app, options = nil)
|
||||
if options
|
||||
path = options.delete(:at)
|
||||
|
|
Loading…
Reference in a new issue