# redact-me

> A utility collection of redacting email address, US phone number or something you don't want to show to others

Latest version **0.0.4** (published 2016-02-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install redact-me
pnpm add redact-me
yarn add redact-me
bun add redact-me
```

## 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.0.4 |
| Published | 2016-02-12 |
| First published | 2016-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Xinjiang Shao |
| Maintainers | soleo |
| Keywords | redact, email, phone, stripper, normalization, secret |

## Links

- npm: https://www.npmjs.com/package/redact-me
- Repository: https://github.com/soleo/redact-me
- Homepage: https://github.com/soleo/redact-me#readme
- Issues: https://github.com/soleo/redact-me/issues
- npm.io page: https://npm.io/package/redact-me

## Dependencies (1)

- [object-assign](https://npm.io/package/object-assign.md) ^4.0.1

## 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

- 0.0.4 (latest) — 2016-02-12
- 0.0.3 — 2016-02-11
- 0.0.2 — 2016-02-10
- 0.0.1 — 2016-02-10

## README

# redact-me [![Build Status](https://travis-ci.org/soleo/redact-me.svg?branch=master)](https://travis-ci.org/soleo/redact-me)

A utility collection of redacting email address, phone number or something you don't want to show to others

## Install

```
$ npm install --save redact-me
```


## Usage

```js
const redact = require('redact-me');

redact('email username@example.com');
//=> 'email'

redact('phone 123-456-7890');
//=> 'phone'

redact('Visa: 4242424242424242');
//=> 'Visa:'

redact('SSN: 000-00-0000');
//=> 'SSN:'

redact('IP Address: 192.168.0.1');
//=> 'IP Address: ';
```


## API

### redact(str, [options])

#### str

Type: `string`

String to redact info from.

#### options

##### stripEmail

Type: `boolean`  
Default: `true`

##### stripPhone

Type: `boolean`  
Default: `true`

##### stripSSN

Type: `boolean`  
Default: `true`

##### stripCreditCard

Type: `boolean`  
Default: `true`

##### stripIpAddress

Type: `boolean`  
Default: `true`

##### redactString

Type: `string`  
Default: `''`

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