• path {string|Buffer|URL}
    • headers {HTTP/2 Headers Object}
    • options {Object}
      • statCheck {Function}
      • onError {Function} Callback function invoked in the case of an error before send.
      • waitForTrailers {boolean} When true, the Http2Stream will emit the 'wantTrailers' event after the final DATA frame has been sent.
      • offset {number} The offset position at which to begin reading.
      • length {number} The amount of data from the fd to send.

    Sends a regular file as the response. The path must specify a regular file or an 'error' event will be emitted on the Http2Stream object.

    When used, the Http2Stream object’s Duplex interface will be closed automatically.

    The optional options.statCheck function may be specified to give user code an opportunity to set additional content headers based on the fs.Stat details of the given file:

    If an error occurs while attempting to read the file data, the Http2Stream will be closed using an RST_STREAM frame using the standard INTERNAL_ERROR code. If the onError callback is defined, then it will be called. Otherwise the stream will be destroyed.

    Example using a file path:

    1. const http2 = require('http2');
    2. const server = http2.createServer();
    3. server.on('stream', (stream) => {
    4.   function statCheck(stat, headers) {
    5.     headers['last-modified'] = stat.mtime.toUTCString();
    6.   }
    8.   function onError(err) {
    9.     if (err.code === 'ENOENT') {
    10.       stream.respond({ ':status': 404 });
    11.     } else {
    12.       stream.respond({ ':status': 500 });
    13.     }
    14.     stream.end();
    15.   }
    17.   stream.respondWithFile('/some/file',
    18.                          { 'content-type': 'text/plain; charset=utf-8' },
    19.                          { statCheck, onError });
    20. });

    The options.statCheck function may also be used to cancel the send operation by returning false. For instance, a conditional request may check the stat results to determine if the file has been modified to return an appropriate 304 response:

    1. const http2 = require('http2');
    2. const server = http2.createServer();
    3. server.on('stream', (stream) => {
    4.   function statCheck(stat, headers) {
    5.     // Check the stat here...
    6.     stream.respond({ ':status': 304 });
    7.     return false; // Cancel the send operation
    8.   }
    9.   stream.respondWithFile('/some/file',
    10.                          { 'content-type': 'text/plain; charset=utf-8' },
    11.                          { statCheck });
    12. });

    The content-length header field will be automatically set.

    The offset and length options may be used to limit the response to a specific range subset. This can be used, for instance, to support HTTP Range requests.

    The options.onError function may also be used to handle all the errors that could happen before the delivery of the file is initiated. The default behavior is to destroy the stream.

    When the options.waitForTrailers option is set, the 'wantTrailers' event will be emitted immediately after queuing the last chunk of payload data to be sent. The http2stream.sendTrailers() method can then be used to sent trailing header fields to the peer.

    When options.waitForTrailers is set, the Http2Stream will not automatically close when the final DATA frame is transmitted. User code must call either http2stream.sendTrailers() or http2stream.close() to close the Http2Stream.

    1. const http2 = require('http2');
    2. const server = http2.createServer();
    3. server.on('stream', (stream) => {
    4.   stream.respondWithFile('/some/file',
    5.                          { 'content-type': 'text/plain; charset=utf-8' },
    6.                          { waitForTrailers: true });
    7.   stream.on('wantTrailers', () => {
    8.     stream.sendTrailers({ ABC: 'some value to send' });
    9.   });
    10. });