# argtor

> Extracts destructured argument names from a function.

Latest version **3.0.0** (published 2022-12-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install argtor
pnpm add argtor
yarn add argtor
bun add argtor
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2022-12-07 |
| First published | 2022-04-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 21.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | stagas |
| Maintainers | stagas |

## Links

- npm: https://www.npmjs.com/package/argtor
- Repository: https://git@github.com/stagas/argtor
- Homepage: https://github.com/stagas/argtor#readme
- Issues: https://github.com/stagas/argtor/issues
- npm.io page: https://npm.io/package/argtor

## Dependencies (1)

- [everyday-types](https://npm.io/package/everyday-types.md) ^1.1.0

## Recent versions

- 3.0.0 (latest) — 2022-12-07
- 2.0.0 — 2022-08-01
- 1.0.4 — 2022-07-30
- 1.0.3 — 2022-07-30
- 1.0.2 — 2022-04-16
- 1.0.1 — 2022-04-09
- 1.0.0 — 2022-04-09

## README

<h1>
argtor <a href="https://npmjs.org/package/argtor"><img src="https://img.shields.io/badge/npm-v3.0.0-F00.svg?colorA=000"/></a> <a href="src"><img src="https://img.shields.io/badge/loc-39-FFF.svg?colorA=000"/></a> <a href="https://cdn.jsdelivr.net/npm/argtor@3.0.0/dist/argtor.min.js"><img src="https://img.shields.io/badge/brotli-320b-333.svg?colorA=000"/></a> <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-F0B.svg?colorA=000"/></a>
</h1>

<p></p>

Extracts destructured argument names from a function.

<h4>
<table><tr><td title="Triple click to select and copy paste">
<code>npm i argtor </code>
</td><td title="Triple click to select and copy paste">
<code>pnpm add argtor </code>
</td><td title="Triple click to select and copy paste">
<code>yarn add argtor</code>
</td></tr></table>
</h4>


## API

<p>  <details id="argtor$1" title="Function" open><summary><span><a href="#argtor$1">#</a></span>  <code><strong>argtor</strong></code><em>(fn, keys)</em>    </summary>  <a href=""></a>  <ul>    <p>    <details id="fn$4" title="Parameter" ><summary><span><a href="#fn$4">#</a></span>  <code><strong>fn</strong></code>    </summary>    <ul><p><span>Fn</span> &amp; {<p>  <details id="fn$6" title="Property" ><summary><span><a href="#fn$6">#</a></span>  <code><strong>fn</strong></code>    </summary>  <a href=""></a>  <ul><p><span>Fn</span></p>        </ul></details></p>}</p>        </ul></details><details id="keys$7" title="Parameter" ><summary><span><a href="#keys$7">#</a></span>  <code><strong>keys</strong></code>  <span><span>&nbsp;=&nbsp;</span>  <code>...</code></span>  </summary>    <ul><p><span>Set</span>&lt;<a href="#T$3">T</a>&gt;</p>        </ul></details>  <p><strong>argtor</strong>&lt;<span>T</span>&gt;<em>(fn, keys)</em>  &nbsp;=&gt;  <ul><a href="#T$3">T</a>  [] &amp; {<p>  <details id="source$9" title="Property" ><summary><span><a href="#source$9">#</a></span>  <code><strong>source</strong></code>  <span><span>&nbsp;=&nbsp;</span>  <code>args.source</code></span>  </summary>  <a href=""></a>  <ul><p>string</p>        </ul></details></p>}</ul></p></p>    </ul></details></p>

## Credits
- [everyday-types](https://npmjs.org/package/everyday-types) by [stagas](https://github.com/stagas) &ndash; Everyday utility types

## Contributing

[Fork](https://github.com/stagas/argtor/fork) or [edit](https://github.dev/stagas/argtor) and submit a PR.

All contributions are welcome!

## License

<a href="LICENSE">MIT</a> &copy; 2022 [stagas](https://github.com/stagas)

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