# maskinput

> Masks the input strings

Latest version **1.0.5** (published 2019-04-08) · MIT license · 0 weekly downloads

## Install

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

Provides the command `maskinput`.

## 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.5 |
| Published | 2019-04-08 |
| First published | 2017-02-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 1 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Amin Shariati |
| Maintainers | shariati |
| Keywords | ansi, app, masked, input, text, cli, cli-app, string, message |

## Links

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

## Dependencies (1)

- [taketalk](https://npm.io/package/taketalk.md) ^1.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2019-04-08
- 1.0.4 — 2017-07-27
- 1.0.3 — 2017-07-27
- 1.0.2 — 2017-06-24
- 1.0.1 — 2017-02-01
- 1.0.0 — 2017-02-01

## README

# maskinput [![npm version](https://badge.fury.io/js/maskinput.svg)](https://badge.fury.io/js/maskinput)[![Build Status](https://travis-ci.org/shariati/maskinput.svg?branch=master)](https://travis-ci.org/shariati/maskinput)[![Coverage Status](https://coveralls.io/repos/github/shariati/maskinput/badge.svg?branch=master)](https://coveralls.io/github/shariati/maskinput?branch=master)[![Known Vulnerabilities](https://snyk.io/test/github/shariati/maskinput/badge.svg)](https://snyk.io/test/github/shariati/maskinput)
Masks the input strings

![](screenshot.png)


## Install

```
$ npm install --save maskinput
```


## Usage

```js
const maskinput = require('maskinput');

console.log(maskinput('john.doe@space.com'));

/*

    ##################

 */
```


## CLI

```
$ npm install --global maskinput
```

```
$ maskinput --help

  Usage
    maskinput <string>
    maskinput <string> --totalUnmaskedTrailingCharacters 10
    maskinput <string> --totalUnmaskedLeadingCharacters 5 --totalUnmaskedTrailingCharacters 10
    maskinput <string> --maskedCharacter X
    echo <string> | maskinput

  Example
    maskinput 'john.doe@space.com'
    ##################

    maskinput 'john.doe@space.com' --maskedCharacter X
    XXXXXXXXXXXXXXXXXX

    maskinput 'john.doe@space.com' --totalUnmaskedLeadingCharacters 5 --totalUnmaskedTrailingCharacters 10
    john.###@space.com

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