12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085 |
- // Type definitions for Express 4.17
- // Project: http://expressjs.com
- // Definitions by: Boris Yankov <https://github.com/borisyankov>
- // Michał Lytek <https://github.com/19majkel94>
- // Kacper Polak <https://github.com/kacepe>
- // Satana Charuwichitratana <https://github.com/micksatana>
- // Sami Jaber <https://github.com/samijaber>
- // Jose Luis Leon <https://github.com/JoseLion>
- // David Stephens <https://github.com/dwrss>
- // Shin Ando <https://github.com/andoshin11>
- // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
- // TypeScript Version: 2.3
- // This extracts the core definitions from express to prevent a circular dependency between express and serve-static
- /// <reference types="node" />
- declare global {
- namespace Express {
- // These open interfaces may be extended in an application-specific manner via declaration merging.
- // See for example method-override.d.ts (https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/method-override/index.d.ts)
- interface Request { }
- interface Response { }
- interface Application { }
- }
- }
- import * as http from "http";
- import { EventEmitter } from "events";
- import { Options as RangeParserOptions, Result as RangeParserResult, Ranges as RangeParserRanges } from "range-parser";
- import { ParsedQs } from "qs";
- export type Query = ParsedQs;
- export interface NextFunction {
- (err?: any): void;
- /**
- * "Break-out" of a router by calling {next('router')};
- * @see {https://expressjs.com/en/guide/using-middleware.html#middleware.router}
- */
- (deferToNext: "router"): void;
- }
- export interface Dictionary<T> { [key: string]: T; }
- export interface ParamsDictionary { [key: string]: string; }
- export type ParamsArray = string[];
- export type Params = ParamsDictionary | ParamsArray;
- export interface RequestHandler<P = ParamsDictionary, ResBody = any, ReqBody = any, ReqQuery = ParsedQs> {
- // tslint:disable-next-line callable-types (This is extended from and can't extend from a type alias in ts<2.2
- (req: Request<P, ResBody, ReqBody, ReqQuery>, res: Response<ResBody>, next: NextFunction): void;
- }
- export type ErrorRequestHandler<P = ParamsDictionary, ResBody = any, ReqBody = any, ReqQuery = ParsedQs> =
- (err: any, req: Request<P, ResBody, ReqBody, ReqQuery>, res: Response<ResBody>, next: NextFunction) => void;
- export type PathParams = string | RegExp | Array<string | RegExp>;
- export type RequestHandlerParams<P = ParamsDictionary, ResBody = any, ReqBody = any, ReqQuery = ParsedQs>
- = RequestHandler<P, ResBody, ReqBody, ReqQuery>
- | ErrorRequestHandler<P, ResBody, ReqBody, ReqQuery>
- | Array<RequestHandler<P>
- | ErrorRequestHandler<P>>;
- export interface IRouterMatcher<T, Method extends 'all' | 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options' | 'head' = any> {
- // tslint:disable-next-line no-unnecessary-generics (This generic is meant to be passed explicitly.)
- <P = ParamsDictionary, ResBody = any, ReqBody = any, ReqQuery = ParsedQs>(path: PathParams, ...handlers: Array<RequestHandler<P, ResBody, ReqBody, ReqQuery>>): T;
- // tslint:disable-next-line no-unnecessary-generics (This generic is meant to be passed explicitly.)
- <P = ParamsDictionary, ResBody = any, ReqBody = any, ReqQuery = ParsedQs>(path: PathParams, ...handlers: Array<RequestHandlerParams<P, ResBody, ReqBody, ReqQuery>>): T;
- (path: PathParams, subApplication: Application): T;
- }
- export interface IRouterHandler<T> {
- (...handlers: RequestHandler[]): T;
- (...handlers: RequestHandlerParams[]): T;
- }
- export interface IRouter extends RequestHandler {
- /**
- * Map the given param placeholder `name`(s) to the given callback(s).
- *
- * Parameter mapping is used to provide pre-conditions to routes
- * which use normalized placeholders. For example a _:user_id_ parameter
- * could automatically load a user's information from the database without
- * any additional code,
- *
- * The callback uses the samesignature as middleware, the only differencing
- * being that the value of the placeholder is passed, in this case the _id_
- * of the user. Once the `next()` function is invoked, just like middleware
- * it will continue on to execute the route, or subsequent parameter functions.
- *
- * app.param('user_id', function(req, res, next, id){
- * User.find(id, function(err, user){
- * if (err) {
- * next(err);
- * } else if (user) {
- * req.user = user;
- * next();
- * } else {
- * next(new Error('failed to load user'));
- * }
- * });
- * });
- */
- param(name: string, handler: RequestParamHandler): this;
- /**
- * Alternatively, you can pass only a callback, in which case you have the opportunity to alter the app.param()
- *
- * @deprecated since version 4.11
- */
- param(callback: (name: string, matcher: RegExp) => RequestParamHandler): this;
- /**
- * Special-cased "all" method, applying the given route `path`,
- * middleware, and callback to _every_ HTTP method.
- */
- all: IRouterMatcher<this, 'all'>;
- get: IRouterMatcher<this, 'get'>;
- post: IRouterMatcher<this, 'post'>;
- put: IRouterMatcher<this, 'put'>;
- delete: IRouterMatcher<this, 'delete'>;
- patch: IRouterMatcher<this, 'patch'>;
- options: IRouterMatcher<this, 'options'>;
- head: IRouterMatcher<this, 'head'>;
- checkout: IRouterMatcher<this>;
- connect: IRouterMatcher<this>;
- copy: IRouterMatcher<this>;
- lock: IRouterMatcher<this>;
- merge: IRouterMatcher<this>;
- mkactivity: IRouterMatcher<this>;
- mkcol: IRouterMatcher<this>;
- move: IRouterMatcher<this>;
- "m-search": IRouterMatcher<this>;
- notify: IRouterMatcher<this>;
- propfind: IRouterMatcher<this>;
- proppatch: IRouterMatcher<this>;
- purge: IRouterMatcher<this>;
- report: IRouterMatcher<this>;
- search: IRouterMatcher<this>;
- subscribe: IRouterMatcher<this>;
- trace: IRouterMatcher<this>;
- unlock: IRouterMatcher<this>;
- unsubscribe: IRouterMatcher<this>;
- use: IRouterHandler<this> & IRouterMatcher<this>;
- route(prefix: PathParams): IRoute;
- /**
- * Stack of configured routes
- */
- stack: any[];
- }
- export interface IRoute {
- path: string;
- stack: any;
- all: IRouterHandler<this>;
- get: IRouterHandler<this>;
- post: IRouterHandler<this>;
- put: IRouterHandler<this>;
- delete: IRouterHandler<this>;
- patch: IRouterHandler<this>;
- options: IRouterHandler<this>;
- head: IRouterHandler<this>;
- checkout: IRouterHandler<this>;
- copy: IRouterHandler<this>;
- lock: IRouterHandler<this>;
- merge: IRouterHandler<this>;
- mkactivity: IRouterHandler<this>;
- mkcol: IRouterHandler<this>;
- move: IRouterHandler<this>;
- "m-search": IRouterHandler<this>;
- notify: IRouterHandler<this>;
- purge: IRouterHandler<this>;
- report: IRouterHandler<this>;
- search: IRouterHandler<this>;
- subscribe: IRouterHandler<this>;
- trace: IRouterHandler<this>;
- unlock: IRouterHandler<this>;
- unsubscribe: IRouterHandler<this>;
- }
- export interface Router extends IRouter { }
- export interface CookieOptions {
- maxAge?: number;
- signed?: boolean;
- expires?: Date;
- httpOnly?: boolean;
- path?: string;
- domain?: string;
- secure?: boolean;
- encode?: (val: string) => string;
- sameSite?: boolean | 'lax' | 'strict' | 'none';
- }
- export interface ByteRange { start: number; end: number; }
- export interface RequestRanges extends RangeParserRanges { }
- export type Errback = (err: Error) => void;
- /**
- * @param P For most requests, this should be `ParamsDictionary`, but if you're
- * using this in a route handler for a route that uses a `RegExp` or a wildcard
- * `string` path (e.g. `'/user/*'`), then `req.params` will be an array, in
- * which case you should use `ParamsArray` instead.
- *
- * @see https://expressjs.com/en/api.html#req.params
- *
- * @example
- * app.get('/user/:id', (req, res) => res.send(req.params.id)); // implicitly `ParamsDictionary`
- * app.get<ParamsArray>(/user\/(.*)/, (req, res) => res.send(req.params[0]));
- * app.get<ParamsArray>('/user/*', (req, res) => res.send(req.params[0]));
- */
- export interface Request<P = ParamsDictionary, ResBody = any, ReqBody = any, ReqQuery = ParsedQs> extends http.IncomingMessage, Express.Request {
- /**
- * 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
- *
- * Aliased as `req.header()`.
- */
- get(name: "set-cookie"): string[] | undefined;
- get(name: string): string | undefined;
- header(name: "set-cookie"): string[] | undefined;
- header(name: string): string | undefined;
- /**
- * 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-delimted 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"
- */
- accepts(): string[];
- accepts(type: string): string | false;
- accepts(type: string[]): string | false;
- accepts(...type: string[]): string | false;
- /**
- * 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.
- */
- acceptsCharsets(): string[];
- acceptsCharsets(charset: string): string | false;
- acceptsCharsets(charset: string[]): string | false;
- acceptsCharsets(...charset: string[]): string | false;
- /**
- * 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.
- */
- acceptsEncodings(): string[];
- acceptsEncodings(encoding: string): string | false;
- acceptsEncodings(encoding: string[]): string | false;
- acceptsEncodings(...encoding: string[]): string | false;
- /**
- * 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.
- */
- acceptsLanguages(): string[];
- acceptsLanguages(lang: string): string | false;
- acceptsLanguages(lang: string[]): string | false;
- acceptsLanguages(...lang: string[]): string | 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.
- * 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.
- *
- */
- range(size: number, options?: RangeParserOptions): RangeParserRanges | RangeParserResult | undefined;
- /**
- * Return an array of Accepted media types
- * ordered from highest quality to lowest.
- */
- accepted: MediaType[];
- /**
- * @deprecated since 4.11 Use either req.params, req.body or req.query, as applicable.
- *
- * Return the value of param `name` when present or `defaultValue`.
- *
- * - Checks route placeholders, ex: _/user/:id_
- * - Checks body params, ex: id=12, {"id":12}
- * - Checks query string params, ex: ?id=12
- *
- * To utilize request bodies, `req.body`
- * should be an object. This can be done by using
- * the `connect.bodyParser()` middleware.
- */
- param(name: string, defaultValue?: any): string;
- /**
- * 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
- */
- is(type: string | string[]): string | false | null;
- /**
- * 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.
- */
- protocol: string;
- /**
- * Short-hand for:
- *
- * req.protocol == 'https'
- */
- secure: boolean;
- /**
- * Return the remote address, or when
- * "trust proxy" is `true` return
- * the upstream addr.
- */
- ip: string;
- /**
- * 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.
- */
- ips: string[];
- /**
- * 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 "tobi.ferrets.example.com":
- * If "subdomain offset" is not set, req.subdomains is `["ferrets", "tobi"]`.
- * If "subdomain offset" is 3, req.subdomains is `["tobi"]`.
- */
- subdomains: string[];
- /**
- * Short-hand for `url.parse(req.url).pathname`.
- */
- path: string;
- /**
- * Parse the "Host" header field hostname.
- */
- hostname: string;
- /**
- * @deprecated Use hostname instead.
- */
- host: string;
- /**
- * Check if the request is fresh, aka
- * Last-Modified and/or the ETag
- * still match.
- */
- fresh: boolean;
- /**
- * Check if the request is stale, aka
- * "Last-Modified" and / or the "ETag" for the
- * resource has changed.
- */
- stale: boolean;
- /**
- * Check if the request was an _XMLHttpRequest_.
- */
- xhr: boolean;
- //body: { username: string; password: string; remember: boolean; title: string; };
- body: ReqBody;
- //cookies: { string; remember: boolean; };
- cookies: any;
- method: string;
- params: P;
- query: ReqQuery;
- route: any;
- signedCookies: any;
- originalUrl: string;
- url: string;
- baseUrl: string;
- app: Application;
- /**
- * After middleware.init executed, Request will contain res and next properties
- * See: express/lib/middleware/init.js
- */
- res?: Response<ResBody>;
- next?: NextFunction;
- }
- export interface MediaType {
- value: string;
- quality: number;
- type: string;
- subtype: string;
- }
- export type Send<ResBody = any, T = Response<ResBody>> = (body?: ResBody) => T;
- export interface Response<ResBody = any, StatusCode extends number = number> extends http.ServerResponse, Express.Response {
- /**
- * Set status `code`.
- */
- status(code: StatusCode): this;
- /**
- * Set the response HTTP status code to `statusCode` and send its string representation as the response body.
- * @link http://expressjs.com/4x/api.html#res.sendStatus
- *
- * Examples:
- *
- * res.sendStatus(200); // equivalent to res.status(200).send('OK')
- * res.sendStatus(403); // equivalent to res.status(403).send('Forbidden')
- * res.sendStatus(404); // equivalent to res.status(404).send('Not Found')
- * res.sendStatus(500); // equivalent to res.status(500).send('Internal Server Error')
- */
- sendStatus(code: StatusCode): this;
- /**
- * 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'
- * });
- */
- links(links: any): this;
- /**
- * Send a response.
- *
- * Examples:
- *
- * res.send(new Buffer('wahoo'));
- * res.send({ some: 'json' });
- * res.send('<p>some html</p>');
- * res.status(404).send('Sorry, cant find that');
- */
- send: Send<ResBody, this>;
- /**
- * Send JSON response.
- *
- * Examples:
- *
- * res.json(null);
- * res.json({ user: 'tj' });
- * res.status(500).json('oh noes!');
- * res.status(404).json('I dont have that');
- */
- json: Send<ResBody, this>;
- /**
- * Send JSON response with JSONP callback support.
- *
- * Examples:
- *
- * res.jsonp(null);
- * res.jsonp({ user: 'tj' });
- * res.status(500).jsonp('oh noes!');
- * res.status(404).jsonp('I dont have that');
- */
- jsonp: Send<ResBody, this>;
- /**
- * Transfer the file at the given `path`.
- *
- * Automatically sets the _Content-Type_ response header field.
- * The callback `fn(err)` is invoked when the transfer is complete
- * or when an error occurs. Be sure to check `res.headersSent`
- * if you wish to attempt responding, as the header and some data
- * may have already been transferred.
- *
- * Options:
- *
- * - `maxAge` defaulting to 0 (can be string converted by `ms`)
- * - `root` root directory for relative filenames
- * - `headers` object of headers to serve with file
- * - `dotfiles` serve dotfiles, defaulting to false; can be `"allow"` to send them
- *
- * Other options are passed along to `send`.
- *
- * 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){
- * var uid = req.params.uid
- * , 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.');
- * }
- * });
- * });
- *
- * @api public
- */
- sendFile(path: string, fn?: Errback): void;
- sendFile(path: string, options: any, fn?: Errback): void;
- /**
- * @deprecated Use sendFile instead.
- */
- sendfile(path: string): void;
- /**
- * @deprecated Use sendFile instead.
- */
- sendfile(path: string, options: any): void;
- /**
- * @deprecated Use sendFile instead.
- */
- sendfile(path: string, fn: Errback): void;
- /**
- * @deprecated Use sendFile instead.
- */
- sendfile(path: string, options: any, fn: Errback): void;
- /**
- * Transfer the file at the given `path` as an attachment.
- *
- * Optionally providing an alternate attachment `filename`,
- * and optional callback `fn(err)`. The callback is invoked
- * when the data transfer is complete, or when an error has
- * ocurred. Be sure to check `res.headersSent` if you plan to respond.
- *
- * The optional options argument passes through to the underlying
- * res.sendFile() call, and takes the exact same parameters.
- *
- * This method uses `res.sendfile()`.
- */
- download(path: string, fn?: Errback): void;
- download(path: string, filename: string, fn?: Errback): void;
- download(path: string, filename: string, options: any, fn?: Errback): void;
- /**
- * Set _Content-Type_ response header with `type` through `mime.lookup()`
- * when it does not contain "/", or set the Content-Type to `type` otherwise.
- *
- * Examples:
- *
- * res.type('.html');
- * res.type('html');
- * res.type('json');
- * res.type('application/json');
- * res.type('png');
- */
- contentType(type: string): this;
- /**
- * Set _Content-Type_ response header with `type` through `mime.lookup()`
- * when it does not contain "/", or set the Content-Type to `type` otherwise.
- *
- * Examples:
- *
- * res.type('.html');
- * res.type('html');
- * res.type('json');
- * res.type('application/json');
- * res.type('png');
- */
- type(type: string): this;
- /**
- * 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>');
- * },
- *
- * 'appliation/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.
- */
- format(obj: any): this;
- /**
- * Set _Content-Disposition_ header to _attachment_ with optional `filename`.
- */
- attachment(filename?: string): this;
- /**
- * Set header `field` to `val`, or pass
- * an object of header fields.
- *
- * Examples:
- *
- * res.set('Foo', ['bar', 'baz']);
- * res.set('Accept', 'application/json');
- * res.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
- *
- * Aliased as `res.header()`.
- */
- set(field: any): this;
- set(field: string, value?: string | string[]): this;
- header(field: any): this;
- header(field: string, value?: string | string[]): this;
- // Property indicating if HTTP headers has been sent for the response.
- headersSent: boolean;
- /** Get value for header `field`. */
- get(field: string): string;
- /** Clear cookie `name`. */
- clearCookie(name: string, options?: any): this;
- /**
- * Set cookie `name` to `val`, with the given `options`.
- *
- * Options:
- *
- * - `maxAge` max-age in milliseconds, converted to `expires`
- * - `signed` sign the cookie
- * - `path` defaults to "/"
- *
- * Examples:
- *
- * // "Remember Me" for 15 minutes
- * res.cookie('rememberme', '1', { expires: new Date(Date.now() + 900000), httpOnly: true });
- *
- * // save as above
- * res.cookie('rememberme', '1', { maxAge: 900000, httpOnly: true })
- */
- cookie(name: string, val: string, options: CookieOptions): this;
- cookie(name: string, val: any, options: CookieOptions): this;
- cookie(name: string, val: any): this;
- /**
- * 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');
- */
- location(url: string): this;
- /**
- * 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.
- *
- * Examples:
- *
- * res.redirect('/foo/bar');
- * res.redirect('http://example.com');
- * res.redirect(301, 'http://example.com');
- * res.redirect('http://example.com', 301);
- * res.redirect('../login'); // /blog/post/1 -> /blog/login
- */
- redirect(url: string): void;
- redirect(status: number, url: string): void;
- redirect(url: string, status: number): void;
- /**
- * 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
- */
- render(view: string, options?: object, callback?: (err: Error, html: string) => void): void;
- render(view: string, callback?: (err: Error, html: string) => void): void;
- locals: Record<string, any>;
- charset: string;
- /**
- * Adds the field to the Vary response header, if it is not there already.
- * Examples:
- *
- * res.vary('User-Agent').render('docs');
- *
- */
- vary(field: string): this;
- app: Application;
- /**
- * 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.
- *
- * Note: calling res.set() after res.append() will reset the previously-set header value.
- *
- * @since 4.11.0
- */
- append(field: string, value?: string[] | string): this;
- /**
- * After middleware.init executed, Response will contain req property
- * See: express/lib/middleware/init.js
- */
- req?: Request;
- }
- export interface Handler extends RequestHandler { }
- export type RequestParamHandler = (req: Request, res: Response, next: NextFunction, value: any, name: string) => any;
- export type ApplicationRequestHandler<T> = IRouterHandler<T> & IRouterMatcher<T> & ((...handlers: RequestHandlerParams[]) => T);
- export interface Application extends EventEmitter, IRouter, Express.Application {
- /**
- * Express instance itself is a request handler, which could be invoked without
- * third argument.
- */
- (req: Request | http.IncomingMessage, res: Response | http.ServerResponse): any;
- /**
- * Initialize the server.
- *
- * - setup default configuration
- * - setup default middleware
- * - setup route reflection methods
- */
- init(): void;
- /**
- * Initialize application configuration.
- */
- defaultConfiguration(): void;
- /**
- * Register the given template engine callback `fn`
- * as `ext`.
- *
- * By default will `require()` the engine based on the
- * file extension. For example if you try to render
- * a "foo.jade" file Express will invoke the following internally:
- *
- * app.engine('jade', require('jade').__express);
- *
- * For engines that do not provide `.__express` out of the box,
- * or if you wish to "map" a different extension to the template engine
- * you may use this method. For example mapping the EJS template engine to
- * ".html" files:
- *
- * app.engine('html', require('ejs').renderFile);
- *
- * In this case EJS provides a `.renderFile()` method with
- * the same signature that Express expects: `(path, options, callback)`,
- * though note that it aliases this method as `ejs.__express` internally
- * so if you're using ".ejs" extensions you dont need to do anything.
- *
- * Some template engines do not follow this convention, the
- * [Consolidate.js](https://github.com/visionmedia/consolidate.js)
- * library was created to map all of node's popular template
- * engines to follow this convention, thus allowing them to
- * work seamlessly within Express.
- */
- engine(ext: string, fn: (path: string, options: object, callback: (e: any, rendered?: string) => void) => void): this;
- /**
- * Assign `setting` to `val`, or return `setting`'s value.
- *
- * app.set('foo', 'bar');
- * app.get('foo');
- * // => "bar"
- * app.set('foo', ['bar', 'baz']);
- * app.get('foo');
- * // => ["bar", "baz"]
- *
- * Mounted servers inherit their parent server's settings.
- */
- set(setting: string, val: any): this;
- get: ((name: string) => any) & IRouterMatcher<this>;
- param(name: string | string[], handler: RequestParamHandler): this;
- /**
- * Alternatively, you can pass only a callback, in which case you have the opportunity to alter the app.param()
- *
- * @deprecated since version 4.11
- */
- param(callback: (name: string, matcher: RegExp) => RequestParamHandler): this;
- /**
- * 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".
- */
- path(): string;
- /**
- * Check if `setting` is enabled (truthy).
- *
- * app.enabled('foo')
- * // => false
- *
- * app.enable('foo')
- * app.enabled('foo')
- * // => true
- */
- enabled(setting: string): boolean;
- /**
- * Check if `setting` is disabled.
- *
- * app.disabled('foo')
- * // => true
- *
- * app.enable('foo')
- * app.disabled('foo')
- * // => false
- */
- disabled(setting: string): boolean;
- /** Enable `setting`. */
- enable(setting: string): this;
- /** Disable `setting`. */
- disable(setting: string): this;
- /**
- * Render the given view `name` name with `options`
- * and a callback accepting an error and the
- * rendered template string.
- *
- * Example:
- *
- * app.render('email', { name: 'Tobi' }, function(err, html){
- * // ...
- * })
- */
- render(name: string, options?: object, callback?: (err: Error, html: string) => void): void;
- render(name: string, callback: (err: Error, html: string) => void): void;
- /**
- * Listen for connections.
- *
- * A node `http.Server` is returned, with this
- * application (which is a `Function`) as its
- * callback. If you wish to create both an HTTP
- * and HTTPS server you may do so with the "http"
- * and "https" modules as shown here:
- *
- * var http = require('http')
- * , https = require('https')
- * , express = require('express')
- * , app = express();
- *
- * http.createServer(app).listen(80);
- * https.createServer({ ... }, app).listen(443);
- */
- listen(port: number, hostname: string, backlog: number, callback?: () => void): http.Server;
- listen(port: number, hostname: string, callback?: () => void): http.Server;
- listen(port: number, callback?: () => void): http.Server;
- listen(callback?: () => void): http.Server;
- listen(path: string, callback?: () => void): http.Server;
- listen(handle: any, listeningListener?: () => void): http.Server;
- router: string;
- settings: any;
- resource: any;
- map: any;
- locals: Record<string, any>;
- /**
- * 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 Express 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.
- */
- routes: any;
- /**
- * Used to get all registered routes in Express Application
- */
- _router: any;
- use: ApplicationRequestHandler<this>;
- /**
- * 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.
- */
- on: (event: string, callback: (parent: Application) => void) => this;
- /**
- * The app.mountpath property contains one or more path patterns on which a sub-app was mounted.
- */
- mountpath: string | string[];
- }
- export interface Express extends Application {
- request: Request;
- response: Response;
- }
|