# datahub-proxy-middleware

> datahub proxy middleware

Latest version **5.0.3** (published 2021-11-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install datahub-proxy-middleware
pnpm add datahub-proxy-middleware
yarn add datahub-proxy-middleware
bun add datahub-proxy-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 | 5.0.3 |
| Published | 2021-11-16 |
| First published | 2017-11-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 9.3 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 18 |
| Maintainers | zyhack, xudafeng, zivyangll, chun_chan |
| Keywords | datahub, middleware |

## Links

- npm: https://www.npmjs.com/package/datahub-proxy-middleware
- Repository: https://github.com/macacajs/datahub-proxy-middleware
- Homepage: https://github.com/macacajs/datahub-proxy-middleware#readme
- Issues: https://github.com/macacajs/datahub-proxy-middleware/issues
- npm.io page: https://npm.io/package/datahub-proxy-middleware

## Dependencies (3)

- [debugger-board](https://npm.io/package/debugger-board.md) 2
- [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^6.1.0
- [http-proxy-middleware](https://npm.io/package/http-proxy-middleware.md) ^0.20.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 5.0.3 (latest) — 2021-11-16
- 5.0.2 — 2021-03-04
- 5.0.1 — 2020-11-30
- 5.0.0 — 2020-05-25
- 4.0.0 — 2020-04-27
- 3.1.1 — 2020-01-14
- 3.1.0 — 2020-01-01
- 3.0.1 — 2019-12-29
- 3.0.0 — 2019-12-29
- 2.0.2 — 2019-01-24
- 2.0.1 — 2019-01-24
- 2.0.0 — 2019-01-24
- 1.0.9 — 2018-01-30
- 1.0.8 — 2017-12-03
- 1.0.7 — 2017-11-30
- … 7 more at https://npm.io/package/datahub-proxy-middleware/versions

## README

# datahub-proxy-middleware

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/datahub-proxy-middleware.svg
[npm-url]: https://npmjs.org/package/datahub-proxy-middleware
[travis-image]: https://img.shields.io/travis/macacajs/datahub-proxy-middleware.svg
[travis-url]: https://travis-ci.org/macacajs/datahub-proxy-middleware
[coveralls-image]: https://img.shields.io/coveralls/macacajs/datahub-proxy-middleware.svg
[coveralls-url]: https://coveralls.io/r/macacajs/datahub-proxy-middleware?branch=master
[download-image]: https://img.shields.io/npm/dm/datahub-proxy-middleware.svg
[download-url]: https://npmjs.org/package/datahub-proxy-middleware

---

> datahub proxy middleware

<!-- GITCONTRIBUTOR_START -->

## Contributors

|[<img src="https://avatars.githubusercontent.com/u/1011681?v=4" width="100px;"/><br/><sub><b>xudafeng</b></sub>](https://github.com/xudafeng)<br/>|[<img src="https://avatars.githubusercontent.com/u/11460601?v=4" width="100px;"/><br/><sub><b>zivyangll</b></sub>](https://github.com/zivyangll)<br/>|[<img src="https://avatars.githubusercontent.com/u/17233599?v=4" width="100px;"/><br/><sub><b>Chan-Chun</b></sub>](https://github.com/Chan-Chun)<br/>|[<img src="https://avatars.githubusercontent.com/u/2139038?v=4" width="100px;"/><br/><sub><b>zhangyuheng</b></sub>](https://github.com/zhangyuheng)<br/>|[<img src="https://avatars.githubusercontent.com/u/15025212?v=4" width="100px;"/><br/><sub><b>zhuyali</b></sub>](https://github.com/zhuyali)<br/>|
| :---: | :---: | :---: | :---: | :---: |


This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Thu Mar 18 2021 13:45:58 GMT+0800`.

<!-- GITCONTRIBUTOR_END -->

## Installment

```bash
$ npm i datahub-proxy-middleware --save-dev
```

## Common Usage

```javascript
const datahubMiddleware = require('datahub-proxy-middleware');

const datahubConfig = {
  proxy: {
    '/api': {
      hub: 'project_name',
      port: 8080,
      hostname: 'localhost',
      pathOptions: {
        start: true
      }
    },
  },
};

datahubMiddleware(app)(datahubConfig);
```

*notice* version 6 has a break change that needs special attention, see [more details](https://github.com/pillarjs/path-to-regexp).

## Use with webpack-dev-server

[live demo](//github.com/macaca-sample/webpack-datahub-sample)

```javascript
const path = require('path');
const DataHub = require('macaca-datahub');
const datahubMiddleware = require('datahub-proxy-middleware');

// datahub config
// document: https://github.com/macacajs/macaca-datahub#configuration

const datahubConfig = {
  port: 5678,
  hostname: '127.0.0.1',
  pathOptions: {
    start: true,
    end: false
  },
  store: path.join(__dirname, '..', 'data'),
  proxy: {
    '/api': {
      hub: 'sample',
    },
  },
  showBoard: true,
};

const defaultDatahub = new DataHub({
  port: datahubConfig.port,
});

// devServer field
devServer: {
  before: app => {
    datahubMiddleware(app)(datahubConfig);
  },
  after: () => {
    defaultDatahub.startServer(datahubConfig).then(() => {
      console.log('datahub ready');
    });
  },
},
```

showBoard will inject [debugger-board](//github.com/macacajs/debugger-board)

## License

The MIT License (MIT)

---
_Source: https://npm.io/package/datahub-proxy-middleware · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
