# simple-cache-control-middleware

> A very simple cache control middleware for express

Latest version **1.0.0** (published 2023-03-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-cache-control-middleware
pnpm add simple-cache-control-middleware
yarn add simple-cache-control-middleware
bun add simple-cache-control-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.0 |
| Published | 2023-03-21 |
| First published | 2023-03-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14.0.0 |
| Dependencies | 1 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ulises Gascon |
| Maintainers | ulisesgascon |
| Keywords | express, middleware, express-middleware, cache, cache-control |

## Links

- npm: https://www.npmjs.com/package/simple-cache-control-middleware
- Repository: https://github.com/UlisesGascon/simple-cache-control-middleware
- Homepage: https://github.com/UlisesGascon/simple-cache-control-middleware#readme
- Issues: https://github.com/UlisesGascon/simple-cache-control-middleware/issues
- npm.io page: https://npm.io/package/simple-cache-control-middleware

## Dependencies (1)

- [debug](https://npm.io/package/debug.md) 4.3.4

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-03-21

## README

<p align="center">
<h1 align="center">
  simple-cache-control-middleware
</h1>

<p align="center">
  A very simple cache control middleware for express
</p>

<p align="center">
  <a href="https://www.npmjs.org/package/simple-cache-control-middleware"><img src="https://badgen.net/npm/v/simple-cache-control-middleware" alt="npm version"/></a>
  <a href="https://www.npmjs.org/package/simple-cache-control-middleware"><img src="https://badgen.net/npm/license/simple-cache-control-middleware" alt="license"/></a>
  <a href="https://www.npmjs.org/package/simple-cache-control-middleware"><img src="https://badgen.net/npm/dt/simple-cache-control-middleware" alt="downloads"/></a>
  <a href="https://snyk.io/test/github/ulisesgascon/simple-cache-control-middleware"><img src="https://snyk.io/test/github/ulisesgascon/simple-cache-control-middleware/badge.svg" alt="Known Vulnerabilities"/></a>
</p>

</p>

# About

A very simple cache control middleware for express.

❤️ Awesome Features:

- Easy to define the max-age 🔥
- Only GET Request are cached 🍺
- `debug` is supported 💪
- Easy to use and great test coverage ✅

## Usage

### Install

```bash
npm install simple-cache-control-middleware
```

### Default

```js
const express = require('express');
const simpleCacheControlMiddleware = require('simple-cache-control-middleware')
const app = express();

app.use(simpleCacheControlMiddleware())

app.get('/', (req, res) => {
  res.send(`This request has 5m max-age`);
});

app.post('/', (req, res) => {
  res.send(`This request is not cached`);
});

app.listen(3000, () => {
  console.log('We are in port 3000!');
});
```

### Custom max-age


```js
const express = require('express');
const simpleCacheControlMiddleware = require('simple-cache-control-middleware')
const app = express();

const TEN_MINUTES = 60 * 10
app.use(simpleCacheControlMiddleware({
    maxAge: TEN_MINUTES
}))
```

## Built With

Development only:

- [Standard](https://www.npmjs.com/package/standard) - Linting
- [Jest](https://www.npmjs.com/package/jest) Testing framework

Production only:

- [debug](https://www.npmjs.com/package/debug) - Debug the app
## Contributing

Please read [CONTRIBUTING.md](https://github.com/UlisesGascon/user-language-middleware/blob/main/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/ulisesGascon/simple-cache-control-middleware/tags).

## Authors

- **Ulises Gascón** - *Initial work- - [@ulisesGascon](https://github.com/ulisesGascon)

See also the list of [contributors](https://github.com/ulisesGascon/simple-cache-control-middleware/contributors) who participated in this project.

## License

This project is licensed under the GNU AGPL3.0 License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

- This project is under development, but you can help us to improve it! We :heart: FOSS!

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