# completor

> Match input in an array for completions

Latest version **1.0.0** (published 2016-01-08) · MIT license · 0 weekly downloads

## Install

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

## 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 | 2016-01-08 |
| First published | 2016-01-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Evan Lucas |
| Maintainers | evanlucas |

## Links

- npm: https://www.npmjs.com/package/completor
- Repository: https://github.com/evanlucas/completor
- Issues: https://github.com/evanlucas/completor/issues
- npm.io page: https://npm.io/package/completor

## Recent versions

- 1.0.0 (latest) — 2016-01-08

## README

# completor

[![Build Status](https://travis-ci.org/evanlucas/completor.svg)](https://travis-ci.org/evanlucas/completor)
[![Coverage Status](https://coveralls.io/repos/evanlucas/completor/badge.svg?branch=master&service=github)](https://coveralls.io/github/evanlucas/completor?branch=master)

Match input in an array for completions.

Say you want to get possible completions for a given string, _str_.
With `completor`, all you have to do is call `completor(str, array)`.

## Install

```bash
$ npm install completor
```

## Usage

```js
const completor = require('completor')

const input = [
  'brad'
, 'dan'
, 'Donald'
, 'Bradley'
, 'evan'
]

completor('br', input)
// => ['brad', 'Bradley']

// can also do
completor.insensitive('br', input)
// => ['brad', 'Bradley']

// or go case sensitive
completor('br', input, true)
// => ['brad']

// can also do
completor.sensitive('br', input)
// => ['brad']
```

## Test

```bash
$ npm test
```

## Author

Evan Lucas

## License

MIT (See `LICENSE` for more info)

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