# get-function-params

> Get list of function params, including default values (if any)

Latest version **2.0.7** (published 2018-09-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install get-function-params
pnpm add get-function-params
yarn add get-function-params
bun add get-function-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 | 2.0.7 |
| Published | 2018-09-17 |
| First published | 2017-02-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 0 |
| Unpacked size | 3.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Phillip Gibson |
| Maintainers | renolc |
| Keywords | function, parameters, arguments, metadata, reflection |

## Links

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

## Recent versions

- 2.0.7 (latest) — 2018-09-17
- 2.0.6 — 2018-09-11
- 2.0.5 — 2018-08-31
- 2.0.4 — 2018-08-31
- 2.0.3 — 2017-08-09
- 2.0.2 — 2017-07-23
- 2.0.1 — 2017-07-22
- 2.0.0 — 2017-03-04
- 1.0.0 — 2017-02-20

## README

# get-function-params [![npm version](https://badge.fury.io/js/get-function-params.svg)](https://badge.fury.io/js/get-function-params)

Get list of function params, including default values (if any).

### Installation

```bash
npm i get-function-params -S
```

### Usage

```js
const getParams = require('get-function-params')

// returns [{ param: 'a' }, { param: 'b' }, { param: 'c' }]
getParams(function(a, b, c) {})

// strips out inline comments
// returns [{ param: 'a' }, { param: 'b' }, { param: 'c' }]
getParams(function(a, b, /* bork */ c) {})

// supports arrow functions
// returns [{ param: 'a' }, { param: 'b' }, { param: 'c' }]
getParams((a, b, c) => {})

// supports default values
// returns [{ param: 'a' }, { param: 'b', default: true }]
getParams((a, b=true) => {})
```

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