# require-params

> require some parameters the easiest way

Latest version **1.1.4** (published 2017-11-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install require-params
pnpm add require-params
yarn add require-params
bun add require-params
```

## 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.1.4 |
| Published | 2017-11-30 |
| First published | 2017-11-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Osama Soliman |
| Maintainers | microsmsm |
| Keywords | params, post, node, missed, utility |

## Links

- npm: https://www.npmjs.com/package/require-params
- Repository: https://github.com/Microsmsm/require-params
- Homepage: https://github.com/Microsmsm/require-params#readme
- Issues: https://github.com/Microsmsm/require-params/issues
- npm.io page: https://npm.io/package/require-params

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.1.4 (latest) — 2017-11-30
- 1.1.3 — 2017-11-29
- 1.1.2 — 2017-11-29
- 1.1.1 — 2017-11-29
- 1.1.0 — 2017-11-29
- 1.0.12 — 2017-11-29
- 1.0.11 — 2017-11-27
- 1.0.10 — 2017-11-27
- 1.0.9 — 2017-11-27
- 1.0.8 — 2017-11-26
- 1.0.7 — 2017-11-26
- 1.0.6 — 2017-11-26
- 1.0.5 — 2017-11-26
- 1.0.4 — 2017-11-26
- 1.0.2 — 2017-11-25
- … 2 more at https://npm.io/package/require-params/versions

## README

# require-params 
[![npm version](https://badge.fury.io/js/require-params.svg)](https://badge.fury.io/js/require-params)
[![GitHub issues](https://img.shields.io/github/issues/Microsmsm/require-params.svg)](https://github.com/Microsmsm/require-params/issues)

Fast, minimalist middleware for express making your life easier.


## Features:

 * Requires important params the easy way
 * Choose to force require params
 * Or return missing params array with the requst object for you to handle 

## Installation:
```
npm i require-params
```

## Usage:

```javascript
app.use(requireParams('/api/endpoint',['text'],true))
```

## Arguments Explaining:

```javascript
requireParams(PATH:String,RequiredParmeters:String[],ForceRequireParams?:Boolean)
```

## Full code example:

```javascript
const express = require('express')
const app = express()

app.use(express.urlencoded({extended: true}));
app.use(express.json())

const requireParams = require('require-params');

app.use(requireParams('/api/endpoint',['text'],true))

app.post('/api/endpoint', (req, res) => {
    //code happens here only when required params are provided when force require is enabled
})
```

Like it :+1:? ... Tweet it [![Twitter](https://img.shields.io/twitter/url/https/www.npmjs.com/package/require-params.svg?style=social)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Frequire-params)


This is on [GitHub](https://github.com/Microsmsm/require-params) your contributions are very welcomed.
[![star this repo](http://githubbadges.com/star.svg?user=Microsmsm&repo=require-params&style=flat)](https://github.com/Microsmsm/require-params)
[![fork this repo](http://githubbadges.com/fork.svg?user=Microsmsm&repo=require-params&style=flat)](https://github.com/Microsmsm/require-params/fork)

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