UNPKG

771 BJavaScriptView Raw
1/**
2 * apeman app contribution plugin to server static files.
3 * @module apeman-app-contrib-servestatic
4 * @see https://github.com/apeman-repo/apeman
5 * @see https://www.npmjs.com/package/serve-static
6 */
7
8"use strict";
9
10/**
11 * Serve static files from within a given root directory.
12 * @function apemanAppContribServestatic
13 * @param {string} root - Root directory path..
14 * @param {object} options - Optional setting.
15 * @param {string} [options.dotfiles='ignore']- How to treat dotfiles. 'allow', 'deny', or 'ignore'..
16 * @param {string} [options.etag=true]- Enable or disable etag generation..
17 * @param {string} [options.extensions=false]- Set file extension fallbacks..
18 * @param {function} [callback] - Callback when done.
19 */
20module.exports = require('./define');