Interface HttpInlineResponse

Represents an HTTP Response.

Hierarchy

  • Response
    • HttpInlineResponse

Properties

app: Application<Record<string, any>>
charset: string
chunkedEncoding: boolean
connection: Socket

Deprecate

Use socket instead.

destroyed: boolean
finished: boolean

Deprecated

Use writableEnded instead.

headersSent: boolean
json: Send<any, HttpInlineResponse>

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');
jsonp: Send<any, HttpInlineResponse>

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');
locals: Record<string, any> & Locals
req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

After middleware.init executed, Response will contain req property See: express/lib/middleware/init.js

send: Send<any, HttpInlineResponse>

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');
sendDate: boolean
shouldKeepAlive: boolean
socket: Socket
statusCode: number
statusMessage: string
upgrading: boolean
useChunkedEncodingByDefault: boolean
writable: boolean
writableCorked: number
writableEnded: boolean
writableFinished: boolean
writableHighWaterMark: number
writableLength: number
writableObjectMode: boolean

Methods

  • Parameters

    • error: Error
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

  • Parameters

    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

  • Parameters

    • chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

  • Event emitter The defined events on documents including:

    1. close
    2. drain
    3. error
    4. finish
    5. pipe
    6. unpipe

    Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • headers: OutgoingHttpHeaders | readonly [string, string][]

    Returns void

  • 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.

    Parameters

    • field: string
    • Optional value: string | string[]

    Returns HttpInlineResponse

    Since

    4.11.0

  • Parameters

    • socket: Socket

    Returns void

  • Set Content-Disposition header to attachment with optional filename.

    Parameters

    • Optional filename: string

    Returns HttpInlineResponse

  • Clear cookie name.

    Parameters

    • name: string
    • Optional options: CookieOptions

    Returns HttpInlineResponse

  • 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');

    Parameters

    • type: string

    Returns HttpInlineResponse

  • 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 })

    Parameters

    • name: string
    • val: string
    • options: CookieOptions

    Returns HttpInlineResponse

  • Parameters

    • name: string
    • val: any
    • options: CookieOptions

    Returns HttpInlineResponse

  • Parameters

    • name: string
    • val: any

    Returns HttpInlineResponse

  • Returns void

  • Parameters

    • Optional error: Error

    Returns void

  • Parameters

    • socket: Socket

    Returns 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().

    Parameters

    • path: string
    • Optional fn: Errback

    Returns void

  • Parameters

    • path: string
    • filename: string
    • Optional fn: Errback

    Returns void

  • Parameters

    • path: string
    • filename: string
    • options: DownloadOptions
    • Optional fn: Errback

    Returns void

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "drain"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "finish"

    Returns boolean

  • Parameters

    • event: "pipe"
    • src: Readable

    Returns boolean

  • Parameters

    • event: "unpipe"
    • src: Readable

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Parameters

    • Optional cb: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional cb: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • Optional cb: (() => void)
        • (): void
        • Returns void

    Returns void

  • Returns (string | symbol)[]

  • Forces the partially-compressed response to be flushed to the client.

    Returns void

  • Returns void

  • 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.

    Parameters

    • obj: any

    Returns HttpInlineResponse

  • Get value for header field.

    Parameters

    • field: string

    Returns string

  • Parameters

    • name: string

    Returns string | number | string[]

  • Returns string[]

  • Returns OutgoingHttpHeaders

  • Returns number

  • Parameters

    • name: string

    Returns boolean

  • Parameters

    • field: any

    Returns HttpInlineResponse

  • Parameters

    • field: string
    • Optional value: string | string[]

    Returns HttpInlineResponse

  • Parameters

    • event: string | symbol

    Returns number

  • Parameters

    • event: string | symbol

    Returns Function[]

  • 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');
    

    Parameters

    • url: string

    Returns HttpInlineResponse

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns HttpInlineResponse

  • Type Parameters

    • T extends WritableStream<T>

    Parameters

    • destination: T
    • Optional options: {
          end?: boolean;
      }
      • Optional end?: boolean

    Returns T

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: string | symbol

    Returns Function[]

  • 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('back'); 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

    Parameters

    • url: string

    Returns void

  • Parameters

    • status: number
    • url: string

    Returns void

  • Parameters

    • url: string
    • status: number

    Returns void

    Deprecated

    use res.redirect(status, url) instead

  • Parameters

    • Optional event: string | symbol

    Returns HttpInlineResponse

  • Parameters

    • name: string

    Returns void

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void
        • Parameters

          • err: Error

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "pipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: "unpipe"
    • listener: ((src) => void)
        • (src): void
        • Parameters

          • src: Readable

          Returns void

    Returns HttpInlineResponse

  • Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns HttpInlineResponse

  • 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

    Parameters

    • view: string
    • Optional options: object
    • Optional callback: ((err, html) => void)
        • (err, html): void
        • Parameters

          • err: Error
          • html: string

          Returns void

    Returns void

  • Parameters

    • view: string
    • Optional callback: ((err, html) => void)
        • (err, html): void
        • Parameters

          • err: Error
          • html: string

          Returns void

    Returns void

  • 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.');
    }
    });
    });

    Parameters

    • path: string
    • Optional fn: Errback

    Returns void

    Api

    public

  • Parameters

    • path: string
    • options: SendFileOptions
    • Optional fn: Errback

    Returns void

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

    Parameters

    • code: number

    Returns HttpInlineResponse

    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')

  • Parameters

    • path: string

    Returns void

    Deprecated

    Use sendFile instead.

  • Parameters

    • path: string
    • options: SendFileOptions

    Returns void

    Deprecated

    Use sendFile instead.

  • Parameters

    • path: string
    • fn: Errback

    Returns void

    Deprecated

    Use sendFile instead.

  • Parameters

    • path: string
    • options: SendFileOptions
    • fn: Errback

    Returns void

    Deprecated

    Use sendFile instead.

  • 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().

    Parameters

    • field: any

    Returns HttpInlineResponse

  • Parameters

    • field: string
    • Optional value: string | string[]

    Returns HttpInlineResponse

  • Parameters

    • encoding: BufferEncoding

    Returns HttpInlineResponse

  • Parameters

    • name: string
    • value: string | number | readonly string[]

    Returns void

  • Parameters

    • msecs: number
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns HttpInlineResponse

  • Set status code.

    Parameters

    • code: number

    Returns HttpInlineResponse

  • 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');

    Parameters

    • type: string

    Returns HttpInlineResponse

  • Returns void

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

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

    Parameters

    • field: string

    Returns HttpInlineResponse

  • Parameters

    • chunk: any
    • Optional cb: ((error) => void)
        • (error): void
        • Parameters

          • error: Error

          Returns void

    Returns boolean

  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • Optional cb: ((error) => void)
        • (error): void
        • Parameters

          • error: Error

          Returns void

    Returns boolean

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • statusCode: number
    • Optional reasonPhrase: string
    • Optional headers: OutgoingHttpHeaders | OutgoingHttpHeader[]

    Returns HttpInlineResponse

  • Parameters

    • statusCode: number
    • Optional headers: OutgoingHttpHeaders | OutgoingHttpHeader[]

    Returns HttpInlineResponse

  • Returns void

Generated using TypeDoc