# contains-pii

> A library for detecting Personally Identifiable Information (PII) in strings of text.

Latest version **0.1.4** (published 2019-12-20) · CC0-1.0 license · 0 weekly downloads

## Install

```sh
npm install contains-pii
pnpm add contains-pii
yarn add contains-pii
bun add contains-pii
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2019-12-20 |
| First published | 2019-12-05 |
| Weekly downloads | 0 |
| License | CC0-1.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Christopher Robert Van Wiemeersch |
| Maintainers | cvan |

## Links

- npm: https://www.npmjs.com/package/contains-pii
- Repository: https://github.com/cvan/contains-pii
- Homepage: https://github.com/cvan/contains-pii#readme
- Issues: https://github.com/cvan/contains-pii/issues
- npm.io page: https://npm.io/package/contains-pii

## Recent versions

- 0.1.4 (latest) — 2019-12-20
- 0.1.3 — 2019-12-20
- 0.1.2 — 2019-12-11
- 0.1.1 — 2019-12-06
- 0.1.0 — 2019-12-05
- 0.0.1 — 2019-12-05

## README

# contains-pii

[![CircleCI](https://circleci.com/gh/cvan/contains-pii.svg?style=svg)](https://circleci.com/gh/cvan/contains-pii)

A library for detecting Personally Identifiable Information (PII) in strings of text.


## Getting started

0. Ensure you have [Node.js 10+](https://nodejs.org/en/download/) and [npm](https://docs.npmjs.com/getting-started/installing-node) installed and available on your system.
1. Clone [this Git repo](https://github.com/cvan/contains-pii):

    ```sh
    git clone git@github.com:cvan/contains-pii.git && cd contains-pii
    ```

2. Install the Node.js dependencies:

    ```sh
    npm install
    ```

3. Run the tests:

    ```sh
    npm test
    ```


## Documentation

- [Guidelines for Contributing](./CONTRIBUTING.md)


## License

All code and text in [this repo](https://github.com/cvan/contains-pii) is [licensed](./LICENSE.md) under the [Creative Commons — CC0 1.0 Universal (CC0 1.0) license](https://creativecommons.org/publicdomain/zero/1.0/).

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