view template file extension
+the directory containing view templates
+Generated using TypeDoc
+Check if the request is fresh, aka + Last-Modified and/or the ETag + still match.
+Parse the "Host" header field to a hostname.
+When the "trust proxy" setting trusts the socket + address, the "X-Forwarded-Host" header field will + be trusted.
+Short-hand for url.parseUrl(req.url).pathname.
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_.
TODO: update docs.
+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", an extension name
+ such as "json", a comma-delimited list such as "json, html, text/plain",
+ an argument 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.
// 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");
+req.accepts("html, json");
+// => "json"
+Check if the given charsets are acceptable,
+ otherwise you should respond with 406 "Not Acceptable".
Check if the given encodings are accepted.
Check if the given langs are acceptable,
+ otherwise you should respond with 406 "Not Acceptable".
Return request header.
+The Referrer header field is special-cased,
+ both Referrer and Referer are interchangeable.
req.get("Content-Type"); // => "text/plain"
+req.get("content-type"); // => "text/plain"
+req.get("Something"); // => undefined
+Check if the incoming request contains the "Content-Type"
+ header field, and it contains the give mime type.
// 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
+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, -1 when unsatisfiable,
+ and -2 when syntactically invalid.
When ranges are returned, the array has a "type" property which is the type of + range that is required (most commonly, "bytes"). Each array element is an object + with a "start" and "end" property for the portion of the range.
+NOTE: remember that ranges are inclusive, so for example "Range: users=0-3" + should respond with 4 users when available, not 3.
+Get value for header field.
Set header field to val, or pass
+ an object of header fields.
res.set("Foo", ["bar", "baz"]);
+res.set("Accept", "application/json");
+res.set({ Accept: "text/plain", "X-API-Key": "tobi" });
+for chaining
Set the location header to url.
The given url can also be "back", which redirects
+ to the Referrer or Referer headers or "/".
res.location("/foo/bar").;
+res.location("http://example.com");
+res.location("../login");
+for chaining
Redirect to the given url with optional response status
+ defaulting to 302.
The resulting url is determined by res.location(), so
+ it will play nicely with mounted apps, relative paths,
+ "back" etc.
res.redirect("/foo/bar");
+res.redirect("http://example.com");
+res.redirect(301, "http://example.com");
+res.redirect("../login"); // /blog/post/1 -> /blog/login
+Send given HTTP status code.
+Sets the response status to statusCode and the body of the
+ response to the standard description from node's http.STATUS_CODES
+ or the statusCode number if no description.
res.sendStatus(200);
+Add field to Vary. If already present in the Vary set, then
+ this call is simply ignored.
for chaining
Generated using TypeDoc
+some html
"); + * res.location("../login"); */ - send(body: string | object | Buffer): this; + location(url: string): this; /** - * Send JSON response. + * Redirect to the given `url` with optional response `status` + * defaulting to 302. + * + * The resulting `url` is determined by `res.location()`, so + * it will play nicely with mounted apps, relative paths, + * `"back"` etc. * * @example - * res.json({ user: "tj" }); + * res.redirect("/foo/bar"); + * @example + * res.redirect("http://example.com"); + * @example + * res.redirect(301, "http://example.com"); + * @example + * res.redirect("../login"); // /blog/post/1 -> /blog/login */ - json(response: object, status?: number): this; + redirect(url: string): void; + redirect(code: number, url: string): void; + + render(view: string, options?: object, callback?: Engine.Callback): void; /** - * Send JSON response with JSONP callback support. + * Send a response. * * @example - * res.jsonp({ user: "tj" }); + * res.send(Buffer.from("wahoo")); + * @example + * res.send({ some: "json" }); + * @example + * res.send("some html
"); */ - jsonp(response: object, status?: number): this; - sendStatus(statusCode: number): this; + send(body: string | object | Buffer): this; /** * Transfer the file at the given `path`. @@ -237,15 +289,34 @@ declare module "http" { * }); */ sendFile(path: string, options?: object | ((...args: any[]) => void), callback?: (...args: any[]) => void): void; - set(field: string | number | object, value: string | string[]): this; - header(field: string | object, value: string | string[]): this; - get(field: string): string | number | string[] | undefined; - location(url: string): this; - redirect(url: string): void; - redirect(code: number, url: string): void; - vary(field: string | string[]): this; - render(view: string, options?: object, callback?: Engine.Callback): void; + /** + * Send given HTTP status code. + * + * Sets the response status to `statusCode` and the body of the + * response to the standard description from node's http.STATUS_CODES + * or the statusCode number if no description. + * + * @example + * res.sendStatus(200); + */ + sendStatus(statusCode: number): this; + + /** + * Set response status code. + * + * @example + * res.status(500); + */ + status(code: number): this; + + /** + * Add `field` to Vary. If already present in the Vary set, then + * this call is simply ignored. + * + * @returns for chaining + */ + vary(field: string | string[]): this; } } @@ -631,6 +702,95 @@ const patch = (res: typeof http.ServerResponse, app: Foxify) => { return this; }; + res.prototype.get = res.prototype.getHeader; + + res.prototype.header = res.prototype.set = function (field, val?) { + if (val) { + let value = Array.isArray(val) + ? val.map((v) => `${v}`) + : `${val}`; + + // add charset to content-type + if ((field as string).toLowerCase() === "content-type") { + if (Array.isArray(value)) throw new TypeError("Content-Type cannot be set to an Array"); + + if (!charsetRegExp.test(value)) { + const charset = (send.mime as any).charsets.lookup(value.split(";")[0]); + + if (charset) value += "; charset=" + charset.toLowerCase(); + } + } + + this.setHeader(
handle view
+