"Break-out" of a router by calling {next('router')};

Special-cased "all" method, applying the given route path, middleware, and callback to every HTTP method.

Stack of configured routes

Dispatch a req, res pair into the application. Starts pipeline processing.

If no callback is provided, then default error handlers will respond in the event of an error bubbling through the stack.

The "combine" option can be set to true and overlapping & adjacent ranges will be combined into a single range.

Return request header.

The Referrer header field is special-cased, both Referrer and Referer are interchangeable.

Examples:

req.get('Content-Type');
// => "text/plain"

req.get('content-type');
// => "text/plain"

req.get('Something');
// => undefined

Return the protocol string "http" or "https" when requested with TLS. When the "trust proxy" setting is enabled the "X-Forwarded-Proto" header field will be trusted. If you're running behind a reverse proxy that supplies https for you this may be enabled.

Short-hand for:

req.protocol == 'https'

Return the remote address, or when "trust proxy" is true return the upstream addr.

When "trust proxy" is true, parse the "X-Forwarded-For" ip address list.

For example if the value were "client, proxy1, proxy2" you would receive the array ["client", "proxy1", "proxy2"] where "proxy2" is the furthest down-stream.

Return subdomains as an array.

Subdomains are the dot-separated parts of the host before the main domain of the app. By default, the domain of the app is assumed to be the last two parts of the host. This can be changed by setting "subdomain offset".

For example, if the domain is "deno.dinosaurs.example.com": If "subdomain offset" is not set, req.subdomains is ["dinosaurs", "deno"]. If "subdomain offset" is 3, req.subdomains is ["deno"].

Returns the pathname of the URL.

Parse the "Host" header field hostname.

Check if the request is fresh, aka Last-Modified and/or the ETag still match.

Check if the request is stale, aka "Last-Modified" and / or the "ETag" for the resource has changed.

Check if the request was an XMLHttpRequest.

Body of request.

If the body has been passed such that a parsedBody property is defined, this returns the parsedBody value.

To always get the raw body value, use the raw property.

Raw body of request.

After middleware.init executed, OpineRequest will contain res and next properties. See: opine/src/middleware/init.ts

After body parsers, OpineRequest will contain _parsedBody boolean property dictating that the body has been parsed. See: opine/src/middleware/bodyParser/

After body parsers, OpineRequest will contain parsedBody property containing the parsed body. See: opine/src/middleware/bodyParser/

After calling parseUrl on the request object, the parsed url is memoization by storing onto the _parsedUrl property.

After calling originalUrl on the request object, the original url is memoization by storing onto the _parsedOriginalUrl property.

Returns a promise that resolves to the response to the request.

Check if the given type(s) is acceptable, returning the best match when true, otherwise undefined, in which case you should respond with 406 "Not Acceptable".

The type value may be a single mime type string such as "application/json", the extension name such as "json", a comma-delimited list such as "json, html, text/plain", or an array ["json", "html", "text/plain"]. When a list or array is given the best match, if any is returned.

Examples:

// Accept: text/html
req.accepts('html');
// => "html"

// Accept: text/*, application/json
req.accepts('html');
// => "html"
req.accepts('text/html');
// => "text/html"
req.accepts('json, text');
// => "json"
req.accepts('application/json');
// => "application/json"

// Accept: text/*, application/json
req.accepts('image/png');
req.accepts('png');
// => undefined

// Accept: text/*;q=.5, application/json
req.accepts(['html', 'json']);
req.accepts('html, json');
// => "json"

Returns the first accepted charset of the specified character sets, based on the request's Accept-Charset HTTP header field. If none of the specified charsets is accepted, returns false.

For more information, or if you have issues or concerns, see accepts.

Returns the first accepted encoding of the specified encodings, based on the request's Accept-Encoding HTTP header field. If none of the specified encodings is accepted, returns false.

For more information, or if you have issues or concerns, see accepts.

Returns the first accepted language of the specified languages, based on the request's Accept-Language HTTP header field. If none of the specified languages is accepted, returns false.

For more information, or if you have issues or concerns, see accepts.

Parse Range header field, capping to the given size.

Unspecified ranges such as "0-" require knowledge of your resource length. In the case of a byte range this is of course the total number of bytes. If the Range header field is not given undefined is returned. If the Range header field is given, return value is a result of range-parser. See more ./types/range-parser/index.d.ts

NOTE: remember that ranges are inclusive, so for example "Range: users=0-3" should respond with 4 users when available, not 3.

Check if the incoming request contains the "Content-Type" header field, and it contains the give mime type.

Examples:

 // With Content-Type: text/html; charset=utf-8
 req.is('html');
 req.is('text/html');
 req.is('text/*');
 // => true

 // When Content-Type is application/json
 req.is('json');
 req.is('application/json');
 req.is('application/*');
 // => true

 req.is('html');
 // => false

Upgrade an HTTP connection to a WebSocket connection by calling Deno.upgradeWebSocket.

Example:

app.get("/ws", async (req, _res, next) => {
  if (req.headers.get("upgrade") === "websocket") {
    const socket = req.upgrade();
    handleSocket(socket);
  } else {
    next();
  }
});

Boolean signifying whether the request has already been responded to.

Send JSON response.

Examples:

res.json(null);
res.json({ user: 'deno' });
res.setStatus(500).json('oh noes!');
res.setStatus(404).json(`I don't have that`);

Send JSON response with JSONP callback support.

Examples:

res.jsonp(null);
res.jsonp({ user: 'deno' });
res.setStatus(500).jsonp('oh noes!');
res.setStatus(404).jsonp(`I don't have that`);

Send a response.

Examples:

res.send(new Buffer('wahoo'));
res.send({ some: 'json' });
res.send('<p>some html</p>');
res.setStatus(404).send('Sorry, cant find that');

Add a resource ID to the list of resources to be closed after the .end() method has been called.

Appends the specified value to the HTTP response header field. If the header is not already set, it creates the header with the specified value. The value parameter can be a string or an array.

Example:

res.append('Set-Cookie', 'foo=bar; Path=/; HttpOnly'); res.append('Warning', '199 Miscellaneous warning'); res.append("cache-control", ["public", "max-age=604800", "immutable"]);

Note: calling res.set() after res.append() will reset the previously-set header value.

Set Content-Disposition header to attachment with optional filename.

Sets a cookie.

Examples:

// "Remember Me" for 15 minutes res.cookie({ name: "rememberme", value: "1", expires: new Date(Date.now() + 900000), httpOnly: true });

Clear cookie by name.

Clear the provided cookie.

Transfer the file at the given path as an attachment.

Optionally providing an alternate attachment filename.

Optionally providing an options object to use with res.sendFile().

This function will set the Content-Disposition header, overriding any existing Content-Disposition header in order to set the attachment and filename.

This method uses res.sendFile().

Sets an ETag header.

Ends a response.

Generally it is recommended to use the res.send() or res.json() methods which will handle automatically setting the Content-Type header, and are able to gracefully handle a greater range of body inputs.

Examples:

res.end();
res.end('<p>some html</p>');
res.setStatus(404).end('Sorry, cant find that');

Respond to the Acceptable formats using an obj of mime-type callbacks.

This method uses req.accepted, an array of acceptable types ordered by their quality values. When "Accept" is not present the first callback is invoked, otherwise the first match is used. When no match is performed the server responds with 406 "Not Acceptable".

Content-Type is set for you, however if you choose you may alter this within the callback using res.type() or res.set('Content-Type', ...).

res.format({ 'text/plain': function(){ res.send('hey'); },

 'text/html': function(){
   res.send('<p>hey</p>');
 },

 'application/json': function(){
   res.send({ message: 'hey' });
 }

});

In addition to canonicalized MIME types you may also use extnames mapped to these types:

res.format({ text: function(){ res.send('hey'); },

 html: function(){
   res.send('<p>hey</p>');
 },

 json: function(){
   res.send({ message: 'hey' });
 }

});

By default Express passes an Error with a .status of 406 to next(err) if a match is not made. If you provide a .default callback it will be invoked instead.

Get value for header field.

Set Link header field with the given links.

Examples:

res.links({ next: 'http://api.example.com/users?page=2', last: 'http://api.example.com/users?page=5' });

Set the location header to url.

The given url can also be the name of a mapped url, for example by default express supports "back" which redirects to the Referrer or Referer headers or "/".

Examples:

res.location('/foo/bar').; res.location('http://example.com'); res.location('../login'); // /blog/post/1 -> /blog/login

Mounting:

When an application is mounted and res.location() is given a path that does not lead with "/" it becomes relative to the mount-point. For example if the application is mounted at "/blog", the following would become "/blog/login".

 res.location('login');

While the leading slash would result in a location of "/login":

 res.location('/login');

Redirect to the given url with optional response status defaulting to 302.

The resulting url is determined by res.location().

Examples:

res.redirect('/foo/bar'); res.redirect('http://example.com'); res.redirect(301, 'http://example.com'); res.redirect('../login'); // /blog/post/1 -> /blog/login

Remove a header from the response

Examples:

res.removeHeader('Accept');

Render view with the given options and optional callback fn. When a callback function is given a response will not be made automatically, otherwise a response of 200 and text/html is given.

Options:

• cache boolean hinting to the engine it should cache
• filename filename of the view being rendered

Transfer the file at the given path.

Automatically sets the Content-Type response header field.

Examples:

The following example illustrates how res.sendFile() may be used as an alternative for the static() middleware for dynamic situations. The code backing res.sendFile() is actually the same code, so HTTP cache support etc is identical.

app.get('/user/:uid/photos/:file', function(req, res){
  const uid = req.params.uid;
  const file = req.params.file;

  req.user.mayViewFilesFrom(uid, function(yes) {
    if (yes) {
      res.sendFile('/uploads/' + uid + '/' + file);
    } else {
      res.send(403, 'Sorry! you cant see that.');
    }
  });
});

Set the response HTTP status code to statusCode and send its string representation as the response body.

Examples:

res.sendStatus(200); // equivalent to res.setStatus(200).send('OK') res.sendStatus(403); // equivalent to res.setStatus(403).send('Forbidden') res.sendStatus(404); // equivalent to res.setStatus(404).send('Not Found') res.sendStatus(500); // equivalent to res.setStatus(500).send('Internal Server Error')

Set header field to val, or pass an object of header fields.

Examples:

res.set('Accept', 'application/json');
res.set({
  'Accept-Language': en-US, en;q=0.5,
  'Accept': 'text/html',
});

Set header field to value, or pass an object of header fields.

alias for res.set()

Examples:

res.setHeader('Accept', 'application/json');
res.setHeader({
  'Accept-Language': "en-US, en;q=0.5",
  'Accept': 'text/html',
});

Set status code.

Set Content-Type response header with type.

Examples:

res.type('.html');
res.type('html');
res.type('json');
res.type('application/json');
res.type('png');

Removes the header field.

Examples:

res.unset('Accept');

Adds the field to the Vary response header, if it is not there already. Examples:

res.vary('User-Agent').render('docs');

Opine instance itself is a request handler, which could be invoked without third argument.

The app.routes object houses all of the routes defined mapped by the associated HTTP verb. This object may be used for introspection capabilities, for example Opine uses this internally not only for routing but to provide default OPTIONS behaviour unless app.options() is used. Your application or framework may also remove routes by simply by removing them from this object.

Used to get all registered routes in Opine Application

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

Initialize the server.

• setup default configuration
• setup default middleware
• setup route reflection methods

Initialize application configuration.

Lazily adds the base router if it has not yet been added.

We cannot add the base router in the defaultConfiguration because it reads app settings which might be set after that has run.

Assign setting to val, or return setting's value.

app.set('foo', 'bar'); app.get('foo'); // => "bar"

Mounted servers inherit their parent server's settings.

Return the app's absolute pathname based on the parent(s) that have mounted it.

For example if the application was mounted as "/admin", which itself was mounted as "/blog" then the return value would be "/blog/admin".

Check if setting is enabled (truthy).

app.enabled('foo') // => false

app.enable('foo') app.enabled('foo') // => true

Check if setting is disabled.

app.disabled('foo') // => true

app.enable('foo') app.disabled('foo') // => false

Enable setting.

Disable setting.

Listen for connections.

A Deno Server is returned.

The mount event is fired on a sub-app, when it is mounted on a parent app. The parent app is passed to the callback function.

NOTE: Sub-apps will:

• Not inherit the value of settings that have a default value. You must set the value in the sub-app.
• Inherit the value of settings with no default value.

Emit an event using the applications event emitter.

Events will be raised based on the passed event string and any listening on() methods will receive the passed arg as an argument.

Register the given template engine callback fn for the provided extension ext.

Render the given view name name with options and a callback accepting an error and the rendered template string.

Example:

app.render('email', { name: 'Deno' }, function(err, html) { // ... })