Home Identifier Source Repository 
import Router from 'hotcakes/src/router.js'
public class | source

Router

You can directly use instance of this class. router

Static Method Summary

Static Public Methods
public static

map(options: Object, callback: Function(router)): *

map binds a set of resources to routes/controllers and returns

Constructor Summary

Public Constructor
public

constructor(options: Object)

Member Summary

Public Members
public

app: *

public
public

Method Summary

Public Methods
public

resource(name: String, options: Object)

resource defines a resource and maps a set of routes to controllers
Private Methods
private

_bindRoute(route: String, method: String, action: Function(req, res, next))

_bindRoute binds a route to a controller action
private

_bindRoutes(resourceName: String, actions: Object, options: Object)

_bindRoutes binds a resource to a set of routes
private

_methodNotAllowedError(req: *, res: *, next: *): *

Static Public Methods

public static map(options: Object, callback: Function(router)): * source

map binds a set of resources to routes/controllers and returns router instance

Params:

NameTypeAttributeDescription
options Object

router config options
options.app Object

Restify app instance
options.controllersPath String

path to controllers directory
options.restify Object

optios to pass to built in restify app
callback Function(router)

router instance for extending resources

Return:

*

Public Constructors

public constructor(options: Object) source

Params:

NameTypeAttributeDescription
options Object

Router config options
options.app Object

Restify app instance
options.controllersPath String

path to controllers directory
options.restify Object

optios to pass to built in restify app

Public Members

public app: * source

public controllers: * source

public controllersPath: * source

Public Methods

public resource(name: String, options: Object) source

resource defines a resource and maps a set of routes to controllers

Params:

NameTypeAttributeDescription
name String

name of the resource
options Object

resource config options
options.path String

override default route name (
options.paramKey String

override default paramKey (id)

Private Methods

private _bindRoute(route: String, method: String, action: Function(req, res, next)) source

_bindRoute binds a route to a controller action

Params:

NameTypeAttributeDescription
route String

the route (/users)
method String

HTTP method
action Function(req, res, next)

controller action

private _bindRoutes(resourceName: String, actions: Object, options: Object) source

_bindRoutes binds a resource to a set of routes

Params:

NameTypeAttributeDescription
resourceName String

name of the resource
actions Object

controller for resource
options Object

resource options
options.path String

override default route name (
options.paramKey String

override default paramKey (id)

private _methodNotAllowedError(req: *, res: *, next: *): * source

Params:

NameTypeAttributeDescription
req *
res *
next *

Return:

*