Application

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def addListener(eventName: String, listener: Function): Application.this.type

Definition Classes
IEventEmitter
def all(path: String, callback: Function, callbacks: Function*): Application.this.type

This method is like the standard app.METHOD() methods, except it matches all HTTP verbs.
This method is like the standard app.METHOD() methods, except it matches all HTTP verbs. It’s useful for mapping “global” logic for specific path prefixes or arbitrary matches. For example, if you put the following at the top of all other route definitions, it requires that all routes from that point on require authentication, and automatically load a user. Keep in mind that these callbacks do not have to act as end-points: loadUser can perform a task, then call next() to continue matching subsequent routes
Definition Classes
Router
Example:
1. app.all(path, callback [, callback ...])
final def asInstanceOf[T0]: T0

Definition Classes
Any
def checkout(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def connect(path: String, callback: Function, callbacks: Function*): Application.this.type

Routes HTTP CONNECT requests to the specified path with the specified callback functions.
Routes HTTP CONNECT requests to the specified path with the specified callback functions. For more information, see the routing guide.
Definition Classes
Router
Example:
1. app.connect(path, callback [, callback ...])
def copy(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def delete(path: String, callback: Function, callbacks: Function*): Application.this.type

Routes HTTP DELETE requests to the specified path with the specified callback functions.
Routes HTTP DELETE requests to the specified path with the specified callback functions. For more information, see the routing guide. You can provide multiple callback functions that behave just like middleware, except these callbacks can invoke next('route') to bypass the remaining route callback(s). You can use this mechanism to impose pre-conditions on a route, then pass control to subsequent routes if there’s no reason to proceed with the current route.
Definition Classes
Router
Example:
1. app.delete(path, callback [, callback ...])
def disable(name: String): Unit

Sets the Boolean setting name to false, where name is one of the properties from the app settings table.
Sets the Boolean setting name to false, where name is one of the properties from the app settings table. Calling app.set('foo', false) for a Boolean property is the same as calling app.disable('foo').
Example:
1. app.disable(name)
def disabled(name: String): Boolean

Returns true if the Boolean setting name is disabled (false), where name is one of the properties from the app settings table.
Returns true if the Boolean setting name is disabled (false), where name is one of the properties from the app settings table.
Example:
1. app.disabled(name)
var domain: String

Definition Classes
IEventEmitter
def emit(name: String, args: Any*): Any

Definition Classes
IEventEmitter
def enable(name: String): Unit

Sets the Boolean setting name to true, where name is one of the properties from the app settings table.
Sets the Boolean setting name to true, where name is one of the properties from the app settings table. Calling app.set('foo', true) for a Boolean property is the same as calling app.enable('foo').
Example:
1. app.enable(name)
def enabled(name: String): Boolean

Returns true if the setting name is enabled (true), where name is one of the properties from the app settings table.
Returns true if the setting name is enabled (true), where name is one of the properties from the app settings table.
Example:
1. app.enabled(name)
def engine(name: String, callback: Function): Unit

Registers the given template engine callback as ext.
Registers the given template engine callback as ext. By default, Express will require() the engine based on the file extension. For example, if you try to render a “foo.jade” file, Express invokes the following internally, and caches the require() on subsequent calls to increase performance.
Example:
1. app.engine(ext, callback)
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get(name: String): UndefOr[String]

Returns the value of name app setting, where name is one of strings in the app settings table.
Returns the value of name app setting, where name is one of strings in the app settings table.
Example:
1. app.get(name)
def get(path: String, callback: Function, callbacks: Function*): Application.this.type

Routes HTTP GET requests to the specified path with the specified callback functions.
Routes HTTP GET requests to the specified path with the specified callback functions. For more information, see the routing guide.
You can provide multiple callback functions that behave just like middleware, except these callbacks can invoke next('route') to bypass the remaining route callback(s). You can use this mechanism to impose pre-conditions on a route, then pass control to subsequent routes if there’s no reason to proceed with the current route.
Definition Classes
Router
Example:
1. app.get(path, callback [, callback ...])
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getMaxListeners(): Int

Definition Classes
IEventEmitter
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
def head(path: String, callback: Function, callbacks: Function*): Application.this.type

Routes HTTP HEAD requests to the specified path with the specified callback functions.
Routes HTTP HEAD requests to the specified path with the specified callback functions. For more information, see the routing guide.
Definition Classes
Router
Example:
1. app.head(path, callback [, callback ...])
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
def listen(port: |[Int, String]): Server

Binds and listens for connections on the specified host and port.
Binds and listens for connections on the specified host and port. This method is identical to Node’s http.Server.listen().
def listen(port: |[Int, String], callback: Function): Server

Binds and listens for connections on the specified host and port.
Binds and listens for connections on the specified host and port. This method is identical to Node’s http.Server.listen().
def listen(port: |[Int, String], hostname: String): Server

Binds and listens for connections on the specified host and port.
Binds and listens for connections on the specified host and port. This method is identical to Node’s http.Server.listen().
def listen(port: |[Int, String], hostname: String, callback: Function): Server

Binds and listens for connections on the specified host and port.
Binds and listens for connections on the specified host and port. This method is identical to Node’s http.Server.listen().
def listen(port: |[Int, String], hostname: String, backlog: Int): Server

Binds and listens for connections on the specified host and port.
Binds and listens for connections on the specified host and port. This method is identical to Node’s http.Server.listen().
def listen(port: |[Int, String], hostname: String, backlog: Int, callback: Function): Server

Binds and listens for connections on the specified host and port.
Binds and listens for connections on the specified host and port. This method is identical to Node’s http.Server.listen().
Example:
1. app.listen(port, [hostname], [backlog], [callback])
def listenerCount(eventName: String): Int

Definition Classes
IEventEmitter
def listeners(eventName: String): Array[Function]

Definition Classes
IEventEmitter
var locals: Any

The app.locals object has properties that are local variables within the application.
The app.locals object has properties that are local variables within the application.

See also
http://expressjs.com/en/api.html#app.locals
def lock(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def m_search(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
Annotations
@JSName( "m-search" )
def merge(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def mkactivity(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def mkcol(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
var mountpath: Any

The app.mountpath property contains one or more path patterns on which a sub-app was mounted.
The app.mountpath property contains one or more path patterns on which a sub-app was mounted.

See also
http://expressjs.com/en/api.html#app.mountpath
def move(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def notify(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def on(eventName: String, listener: Function): Application.this.type

Definition Classes
IEventEmitter
def once(eventName: String, listener: Function): Application.this.type

Definition Classes
IEventEmitter
def options(path: String, callback: Function, callbacks: Function*): Application.this.type

Routes HTTP OPTIONS requests to the specified path with the specified callback functions.
Routes HTTP OPTIONS requests to the specified path with the specified callback functions. For more information, see the routing guide.
Definition Classes
Router
Example:
1. app.options(path, callback [, callback ...])
def param(callback: Function): Unit

Definition Classes
Router
def param(names: Array[String], callback: Function): Unit

Definition Classes
Router
def param(name: String, callback: Function): Unit

Add callback triggers to route parameters, where name is the name of the parameter or an array of them, and callback is the callback function.
Add callback triggers to route parameters, where name is the name of the parameter or an array of them, and callback is the callback function. The parameters of the callback function are the request object, the response object, the next middleware, the value of the parameter and the name of the parameter, in that order.
If name is an array, the callback trigger is registered for each parameter declared in it, in the order in which they are declared. Furthermore, for each declared parameter except the last one, a call to next inside the callback will call the callback for the next declared parameter. For the last parameter, a call to next will call the next middleware in place for the route currently being processed, just like it would if name were just a string.
Definition Classes
Router
Example:
1. app.param([name], callback)
def patch(path: String, callback: Function, callbacks: Function*): Application.this.type

Routes HTTP PATCH requests to the specified path with the specified callback functions.
Routes HTTP PATCH requests to the specified path with the specified callback functions. For more information, see the routing guide.
Definition Classes
Router
Example:
1. app.patch(path, callback [, callback ...])
def path(): String

Returns the canonical path of the app, a string.
Returns the canonical path of the app, a string.
Example:
1. app.path()
def post(path: String, callback: Function, callbacks: Function*): Application.this.type

Routes HTTP POST requests to the specified path with the specified callback functions.
Routes HTTP POST requests to the specified path with the specified callback functions. For more information, see the routing guide.
You can provide multiple callback functions that behave just like middleware, except that these callbacks can invoke next('route') to bypass the remaining route callback(s). You can use this mechanism to impose pre-conditions on a route, then pass control to subsequent routes if there’s no reason to proceed with the current route.
Definition Classes
Router
Example:
1. app.post(path, callback [, callback ...])
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
def propfind(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def proppatch(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def purge(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def put(path: String, callback: Function, callbacks: Function*): Application.this.type

Routes HTTP PUT requests to the specified path with the specified callback functions.
Routes HTTP PUT requests to the specified path with the specified callback functions. For more information, see the routing guide.
You can provide multiple callback functions that behave just like middleware, except that these callbacks can invoke next('route') to bypass the remaining route callback(s). You can use this mechanism to impose pre-conditions on a route, then pass control to subsequent routes if there’s no reason to proceed with the current route.
Definition Classes
Router
Example:
1. app.put(path, callback [, callback ...])
def removeAllListeners(): Application.this.type

Definition Classes
IEventEmitter
def removeAllListeners(eventName: String): Application.this.type

Definition Classes
IEventEmitter
def removeListener(eventName: String, listener: Function): Application.this.type

Definition Classes
IEventEmitter
def render(view: String, locals: Any, callback: Function): Unit

Returns the rendered HTML of a view via the callback function.
Returns the rendered HTML of a view via the callback function. It accepts an optional parameter that is an object containing local variables for the view. It is like res.render(), except it cannot send the rendered view to the client on its own.
Example:
1. app.render(view, [locals], callback)
def report(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def route(path: String): Any

Returns an instance of a single route, which you can then use to handle HTTP verbs with optional middleware.
Returns an instance of a single route, which you can then use to handle HTTP verbs with optional middleware. Use app.route() to avoid duplicate route names (and thus typo errors).
Example:
1. app.route(path)
def search(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def set(headers: Any): Application.this.type
def set(name: String, value: Any): Application.this.type

Assigns setting name to value, where name is one of the properties from the app settings table.
Assigns setting name to value, where name is one of the properties from the app settings table. Calling app.set('foo', true) for a Boolean property is the same as calling app.enable('foo'). Similarly, calling app.set('foo', false) for a Boolean property is the same as calling app.disable('foo'). Retrieve the value of a setting with app.get().
Example:
1. app.set(name, value)
def setMaxListeners(n: Int): Application.this.type

Definition Classes
IEventEmitter
def subscribe(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
def trace(path: String, callback: Function, callbacks: Function*): Application.this.type

Routes HTTP TRACE requests to the specified path with the specified callback functions.
Routes HTTP TRACE requests to the specified path with the specified callback functions. For more information, see the routing guide.
Definition Classes
Router
Example:
1. app.trace(path, callback [, callback ...])
def unlock(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def unsubscribe(path: String, callback: Function, callbacks: Function*): Unit

Definition Classes
Router
def use(router: |[Router, Any]): Application.this.type

Mounts the specified middleware function or functions at the specified path.
Mounts the specified middleware function or functions at the specified path. If path is not specified, it defaults to “/”.
Example:
1. app.use([path,] function [, function...])
def use(callback: Function, next: Function*): Application.this.type

Mounts the specified middleware function or functions at the specified path.
Mounts the specified middleware function or functions at the specified path. If path is not specified, it defaults to “/”.
Example:
1. app.use([path,] function [, function...])
def use(path: String, callback: Function, next: Function*): Application.this.type

Mounts the specified middleware function or functions at the specified path.
Mounts the specified middleware function or functions at the specified path. If path is not specified, it defaults to “/”.
Example:
1. app.use([path,] function [, function...])
def use(path: String, router: |[Router, Any]): Application.this.type

Mounts the specified middleware function or functions at the specified path.
Mounts the specified middleware function or functions at the specified path. If path is not specified, it defaults to “/”.
Example:
1. app.use([path,] function [, function...])
var usingDomains: Boolean

Definition Classes
IEventEmitter
def valueOf(): Any

Definition Classes
Object
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def configure(init: Function): Unit

app.configure has been removed in Express 4.x.
app.configure has been removed in Express 4.x.
Annotations
@deprecated
Deprecated
(Since version 4.x) app.configure has been removed
Example:
1. app.configure(init)

Related Docs: object Application | package express

trait Application extends Object with IEventEmitter with Router

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addListener(eventName: String, listener: Function): Application.this.type

def all(path: String, callback: Function, callbacks: Function*): Application.this.type

final def asInstanceOf[T0]: T0

def checkout(path: String, callback: Function, callbacks: Function*): Unit

def clone(): AnyRef

def connect(path: String, callback: Function, callbacks: Function*): Application.this.type

def copy(path: String, callback: Function, callbacks: Function*): Unit

def delete(path: String, callback: Function, callbacks: Function*): Application.this.type

def disable(name: String): Unit

def disabled(name: String): Boolean

var domain: String

def emit(name: String, args: Any*): Any

def enable(name: String): Unit

def enabled(name: String): Boolean

def engine(name: String, callback: Function): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def get(name: String): UndefOr[String]

def get(path: String, callback: Function, callbacks: Function*): Application.this.type

final def getClass(): Class[_]

def getMaxListeners(): Int

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

def head(path: String, callback: Function, callbacks: Function*): Application.this.type

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

def listen(port: |[Int, String]): Server

def listen(port: |[Int, String], callback: Function): Server

def listen(port: |[Int, String], hostname: String): Server

def listen(port: |[Int, String], hostname: String, callback: Function): Server

def listen(port: |[Int, String], hostname: String, backlog: Int): Server

def listen(port: |[Int, String], hostname: String, backlog: Int, callback: Function): Server

def listenerCount(eventName: String): Int

def listeners(eventName: String): Array[Function]

var locals: Any

def lock(path: String, callback: Function, callbacks: Function*): Unit

def m_search(path: String, callback: Function, callbacks: Function*): Unit

def merge(path: String, callback: Function, callbacks: Function*): Unit

def mkactivity(path: String, callback: Function, callbacks: Function*): Unit

def mkcol(path: String, callback: Function, callbacks: Function*): Unit

var mountpath: Any

def move(path: String, callback: Function, callbacks: Function*): Unit

final def ne(arg0: AnyRef): Boolean

def notify(path: String, callback: Function, callbacks: Function*): Unit

final def notify(): Unit

final def notifyAll(): Unit

def on(eventName: String, listener: Function): Application.this.type

def once(eventName: String, listener: Function): Application.this.type

def options(path: String, callback: Function, callbacks: Function*): Application.this.type

def param(callback: Function): Unit

def param(names: Array[String], callback: Function): Unit

def param(name: String, callback: Function): Unit

def patch(path: String, callback: Function, callbacks: Function*): Application.this.type

def path(): String

def post(path: String, callback: Function, callbacks: Function*): Application.this.type

def propertyIsEnumerable(v: String): Boolean

def propfind(path: String, callback: Function, callbacks: Function*): Unit

def proppatch(path: String, callback: Function, callbacks: Function*): Unit

def purge(path: String, callback: Function, callbacks: Function*): Unit

def put(path: String, callback: Function, callbacks: Function*): Application.this.type

def removeAllListeners(): Application.this.type

def removeAllListeners(eventName: String): Application.this.type

def removeListener(eventName: String, listener: Function): Application.this.type

def render(view: String, locals: Any, callback: Function): Unit

def report(path: String, callback: Function, callbacks: Function*): Unit

def route(path: String): Any

def search(path: String, callback: Function, callbacks: Function*): Unit

def set(headers: Any): Application.this.type

def set(name: String, value: Any): Application.this.type

def setMaxListeners(n: Int): Application.this.type

def subscribe(path: String, callback: Function, callbacks: Function*): Unit

final def synchronized[T0](arg0: ⇒ T0): T0