send静态文件模块 - Node.js参考——模具行业从业者必备知识手册

system 2

[![NPM Version][npm-version-image]][npm-url]
[![NPM Downloads][npm-downloads-image]][npm-url]
[![Linux Build][github-actions-ci-image]][github-actions-ci-url]
[![Windows Build][appveyor-image]][appveyor-url]
[![Test Coverage][coveralls-image]][coveralls-url]

Send is a library for streaming files from the file system as a http response
supporting partial responses (Ranges), conditional-GET negotiation (If-Match,
If-Unmodified-Since, If-None-Match, If-Modified-Since), high test coverage,
and granular events which may be leveraged to take appropriate actions in your
application or framework.

Looking to serve up entire folders mapped to URLs? Try <a href="https://www.npmjs.org/package/serve-static">serve-static</a>.

<h3>Installation</h3>

This is a <a href="https://nodejs.org/en/">Node.js</a> module available through the
<a href="https://www.npmjs.com/">npm registry</a>. Installation is done using the
<a href="https://docs.npmjs.com/getting-started/installing-npm-packages-locally"><code>npm install</code> command</a>:

<pre><code>
$ npm install send
</code></pre>

<pre><code>
var send = require('send')
</code></pre>

<h4>send(req, path, [options])</h4>

Create a new <code>SendStream</code> for the given path to send to a <code>res</code>. The <code>req</code> is
the Node.js HTTP request and the <code>path</code> is a urlencoded path to send (urlencoded,
not the actual file-system path).

#### Options

##### acceptRanges

Enable or disable accepting ranged requests, defaults to true.
Disabling this will not send <code>Accept-Ranges</code> and ignore the contents
of the <code>Range</code> request header.

##### cacheControl

Enable or disable setting <code>Cache-Control</code> response header, defaults to
true. Disabling this will ignore the <code>immutable</code> and <code>maxAge</code> options.

##### dotfiles

Set how "dotfiles" are treated when encountered. A dotfile is a file
or directory that begins with a dot ("."). Note this check is done on
the path itself without checking if the path actually exists on the
disk. If <code>root</code> is specified, only the dotfiles above the root are
checked (i.e. the root itself can be within a dotfile when when set
to "deny").

<ul>
<li><code>'allow'</code> No special treatment for dotfiles.</li>
<li><code>'deny'</code> Send a 403 for any request for a dotfile.</li>
<li><code>'ignore'</code> Pretend like the dotfile does not exist and 404.</li>
</ul>

The default value is similar to <code>'ignore'</code>, with the exception that
this default will not ignore the files within a directory that begins
with a dot, for backward-compatibility.

##### end

Byte offset at which the stream ends, defaults to the length of the file
minus 1. The end is inclusive in the stream, meaning <code>end: 3</code> will include
the 4th byte in the stream.

##### etag

Enable or disable etag generation, defaults to true.

##### extensions

If a given file doesn't exist, try appending one of the given extensions,
in the given order. By default, this is disabled (set to <code>false</code>). An
example value that will serve extension-less HTML files: <code>['html', 'htm']</code>.
This is skipped if the requested file already has an extension.

##### immutable

Enable or disable the <code>immutable</code> directive in the <code>Cache-Control</code> response
header, defaults to <code>false</code>. If set to <code>true</code>, the <code>maxAge</code> option should
also be specified to enable caching. The <code>immutable</code> directive will prevent
supported clients from making conditional requests during the life of the
<code>maxAge</code> option to check if the file has changed.

##### index

By default send supports "index.html" files, to disable this
set <code>false</code> or to supply a new index pass a string or an array
in preferred order.

##### lastModified

Enable or disable `Last-Modif

<hr>
踩过坑的来评论区说说。