Router Class
The router class allows the registration of routes and handles requests. It extends the EventEmitter class. For predictability, the router only passes a Request object, a Response object, and a Server object argument respectively. objects to each action function. Stackpress route actions can be defined in four ways.
NOTE: The router class handles action, import and view routing so you don't have to worry about which one to use.
entries
Returns a map of route entries that are logged using . You can use this to compare against the and properties for analytics and building production code. Entries are mapped like the following where entry is a filepath instead of an action function.
❐ Copy
Example
❐ Copy
imports
Returns a map of route imports that are logged using . You can use this to compare against the and properties for analytics and building production code. Imports are mapped like the following where import is a no-argument callback that returns an import ie. .
❐ Copy
Example
❐ Copy
listeners
Returns a read-only shallow copy of the listeners. Listeners are organized by events and events can have multiple listeners and listeners have priorities. The listeners are not pre-organized by priority. This happens during the event loop.
❐ Copy
routes
Returns all the routes that are registered with the router. You can use this to compare against the and properties for analytics and building production code. Routes are mapped like the following.
❐ Copy
Example
❐ Copy
views
Returns a map of route views that are logged using . You can use this to compare against the and properties for analytics and building production code. Views are mapped like the following where entry is a filepath instead of an action function.
❐ Copy
Example
❐ Copy
all()
A shortcut for .
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
connect()
A shortcut for .
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
delete()
A shortcut for .
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
emit()
Calls all the callbacks of the given event passing the given arguments.
Usage
❐ Copy
Example
❐ Copy
get()
A shortcut for .
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
head()
A shortcut for .
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
on()
Adds an action callback to the given event listener.
Usage
❐ Copy
Example
❐ Copy
options()
A shortcut for .
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
patch()
A shortcut for .
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
post()
A shortcut for .
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
put()
A shortcut for .
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
request()
Creates a new request.
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
❐ Copy
Where as the are as follows.
❐ Copy
resolve()
Resolves an event or route. Similar to except you can pass an object as a request, and both request and response are optional.
Usage
❐ Copy
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
❐ Copy
response()
Creates a new response.
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
Where as the are as follows.
❐ Copy
route()
Registers a route with the router.
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
trace()
A shortcut for .
Usage
❐ Copy
Example
❐ Copy
❐ Copy
❐ Copy
use()
Allows routes from other routers to apply here.
Usage
❐ Copy
Example
❐ Copy