serve-static middleware

インストール

これは、 Node.js モジュールで、 npm registry を介して利用できます。インストールは npm install コマンド:

npm install serve-static

serve-static does not include its own TypeScript type definitions. If you use TypeScript, also install the community-maintained types from DefinitelyTyped as a development dependency:

npm install --save-dev @types/serve-static

API

const serveStatic = require('serve-static');

指定したルートディレクトリ内からファイルを提供する新しいミドルウェア関数を作成します。 req.url と指定されたルートディレクトリを組み合わせることで、サービスを提供するファイルを決定します。 When a file is not found, instead of sending a 404 response, this module will instead call next() to move on to the next middleware, allowing for stacking and fall-backs.

オプション

acceptRanges

指定されたリクエストの受け付けを有効または無効にします。デフォルトは true です。 Disabling this will not send Accept-Ranges and ignore the contents of the Range request header.

cacheControl

Cache-Control レスポンスヘッダーの設定を有効または無効にします。デフォルトは true です。これを無効にすると、 immutable と maxAge オプションは無視されます。

dotfiles

「dotfiles」が発生したときにどのように扱われるかを設定します。ドットファイルは、またはドット(.)で始まるディレクトリです。このチェックは、実際にパスがディスク上に存在するかどうかをチェックすることなく、で行われます。 If root is specified, only the dotfiles above the root are checked (i.e. the root itself can be within a dotfile when set to “deny”).

'allow' dotfilesに特別な処理はありません。
'deny' dotfileと403/next()のリクエストを拒否します。
'ignore' dotfileが存在せず、404/next()と同じようにしてください。

デフォルト値は 'ignore' です。

etag

etag の生成を有効または無効にします。デフォルトは true です。

extensions

ファイル拡張子のフォールバックを設定します。設定すると、ファイルが見つからない場合、指定された拡張子がファイル名に追加され、検索されます。が存在する最初のものが提供されます。 Example: ['html', 'htm'].

デフォルト値は false です。

Fallthrough

クライアントエラーが処理されていないリクエストとしてフォールスルーされるミドルウェアを設定します。そうでなければ、クライアントエラーを転送します。違いは、悪いリクエストや存在しないファイルへのリクエストなどのクライアントエラーが発生すると、このミドルウェアは単純に次のミドルウェアにnext()が発生します。この値はがtrueの場合。この値が false の場合、これらのエラー (404でさえ) は next(err) を呼び出します。

通常、複数の物理ディレクトリが同じウェブアドレスまたは存在しないファイルを埋めるルートにマッピングされるように、true が必要です。

The value false can be used if this middleware is mounted at a path that is designed to be strictly a single file system directory, which allows for short-circuiting 404s for less overhead. このミドルウェアはすべてのメソッドにも返信します。

デフォルト値は true です。

res the response object
送信されるファイルのパス path
stat 送信されているファイルの stat オブジェクト

例

vanilla node.js http サーバーでファイルを提供します

const finalhandler = require('finalhandler');
const http = require('http');
const serveStatic = require('serve-static');

// Serve up public/ftp folder
const serve = serveStatic('public/ftp', { index: ['index.html', 'index.htm'] });

// Create server
const server = http.createServer((req, res) => {
  serve(req, res, finalhandler(req, res));
});

// Listen
server.listen(3000);

すべてのファイルをダウンロードとして提供

const contentDisposition = require('content-disposition');
const finalhandler = require('finalhandler');
const http = require('http');
const serveStatic = require('serve-static');

// Serve up public/ftp folder
const serve = serveStatic('public/ftp', {
  index: false,
  setHeaders: setHeaders,
});

// Set header to force download
function setHeaders(res, path) {
  res.setHeader('Content-Disposition', contentDisposition(path));
}

// Create server
const server = http.createServer((req, res) => {
  serve(req, res, finalhandler(req, res));
});

// Listen
server.listen(3000);

急行を利用してサービング

単純な

これは、Expressを使用した簡単な例です。

const express = require('express');
const serveStatic = require('serve-static');

const app = express();

app.use(serveStatic('public/ftp', { index: ['default.html', 'default.htm'] }));
app.listen(3000);

複数のルート

この例では、複数のディレクトリを検索する簡単な方法を示しています。 Files are searched for in public-optimized/ first, then public/ second as a fallback.

const express = require('express');
const path = require('path');
const serveStatic = require('serve-static');

const app = express();

app.use(serveStatic(path.join(__dirname, 'public-optimized')));
app.use(serveStatic(path.join(__dirname, 'public')));
app.listen(3000);

パスの異なる設定

この例では、送信されたファイルによって異なる最大年齢を設定する方法を示します。この例では、HTMLファイルはキャッシュされませんが、はすべて1日間です。

const express = require('express');
const path = require('path');
const serveStatic = require('serve-static');

const app = express();

app.use(
  serveStatic(path.join(__dirname, 'public'), {
    maxAge: '1d',
    setHeaders: setCustomCacheControl,
  })
);

app.listen(3000);

function setCustomCacheControl(res, file) {
  if (path.extname(file) === '.html') {
    // Custom Cache-Control for HTML files
    res.setHeader('Cache-Control', 'public, max-age=0');
  }
}

ライセンス

MIT

serve-static middleware

インストール

API

serveStatic(root, options)