# masked

> Mask sensitive values in objects

Latest version **1.2.1** (published 2018-06-18) · MIT license · 5.5K weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2018-06-18 |
| First published | 2018-02-01 |
| Weekly downloads | 5.5K |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 1 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | jxom |
| Maintainers | jmoxey |
| Keywords | mask, data, sensitive |

## Links

- npm: https://www.npmjs.com/package/masked
- Repository: https://github.com/jxom/masked
- Homepage: https://github.com/jxom/masked#readme
- Issues: https://github.com/jxom/masked/issues
- npm.io page: https://npm.io/package/masked

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.17.4

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads
- [@metaobjectsdev/codegen-ts-tanstack](https://npm.io/package/@metaobjectsdev/codegen-ts-tanstack.md) — 2.6K weekly downloads

## Recent versions

- 1.2.1 (latest) — 2018-06-18
- 1.1.0 — 2018-02-02
- 1.0.2 — 2018-02-02
- 1.0.1 — 2018-02-01
- 1.0.0 — 2018-02-01

## README

# Masked [![Build Status](https://travis-ci.org/jxom/masked.svg?branch=master)](https://travis-ci.org/jxom/masked)

> Mask sensitive values in a collection


## Install

```
$ npm install masked
```


## Usage

```js
import masked from 'masked';

const user = {
  firstName: 'jake',
  password: 'IAmCool',
  mobileNumbers: ['0400123123', '0411223444'],
  providerData: [{ providerNumber: '123456' }, { providerNumber: '123456' }]
};

const maskedUser = masked(user, ['password', 'mobileNumbers', 'providerData']);
/*
maskedUser =
  {
    firstName: 'jake',
    password: '********',
    mobileNumbers: ['********', '********'],
    providerData: [{ providerNumber: '********' }, { providerNumber: '********' }]
  }
*/
```

and [here](https://github.com/jxom/masked/blob/master/test.js)


## API

### masked(data, keys[, opts])

#### data

Type: `Object` or `Array<Object>`

The data that you want to mask.

#### keys

Type: `string` or `Array`

The sensitive keys in your `data`.

#### opts

##### omitKeys

Type: `boolean`

Default value: `false`

If `true`, it will omit the keys completely from the data.


## License

MIT © [jxom](http://jxom.io)

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