# @wiredcraft/express-serve-file-middleware

> express serve file middleware

Latest version **1.0.1** (published 2021-10-20) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install @wiredcraft/express-serve-file-middleware
pnpm add @wiredcraft/express-serve-file-middleware
yarn add @wiredcraft/express-serve-file-middleware
bun add @wiredcraft/express-serve-file-middleware
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-10-20 |
| First published | 2021-08-16 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Frank Shen |
| Maintainers | raohael_biland, yadong_zhang, kikiatwcl, liyachun01, echoyueyu, wiredcraft-bot, makara, xavierchow, wwayne, drakexiang, kaleocheng, flyingant, ccharlieli, illuminati1911, ilya_wiredcraft, rankun203, superbogy, miffyliye, lalawow, bsdelf, maxiaobao, shuaibird, juhas, cyrilselasi, xiao_t, agreatfool, haishanh, chopperlee2011, woodpig07, dowla, ivanbar, eronekogin, kuno, xpol, wangjianting, estemomento |
| Keywords | express, loopback, file, wiredcraft |

## Links

- npm: https://www.npmjs.com/package/@wiredcraft/express-serve-file-middleware
- Repository: https://github.com/Wiredcraft/omni-libs
- Homepage: https://github.com/Wiredcraft/omni-libs#readme
- Issues: https://github.com/Wiredcraft/omni-libs/issues
- npm.io page: https://npm.io/package/@wiredcraft/express-serve-file-middleware

## Dependencies (1)

- [send](https://npm.io/package/send.md) ^0.17.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-10-20
- 1.0.0 — 2021-08-16
- 1.0.0-rc.1 — 2021-08-16

## README

# `@wiredcraft/express-serve-file-middleware`

Serve files with a predefined request path to file path mapping.

## Usage

Express:

```js
const createMiddleware = require('@wiredcraft/exporess-serve-file-middleware');
const app = express();
const middleware = createMiddleware({
  routeToFiles: {
    '/readme': './README.md'
  }
});
app.use(middleware);
const server = app.listen(3000);
```

For loopback v2, add these section to "middleware.json":

```json
"routes:before": {
    "@wiredcraft/serve-file-middleware": {
      "params": {
        "routeToFiles": {
          "/readme": "README.md"
        }
      }
    }
  },
```

---
_Source: https://npm.io/package/@wiredcraft/express-serve-file-middleware · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._