# cs-mask

> Library mask

Latest version **0.0.2** (published 2020-04-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install cs-mask
pnpm add cs-mask
yarn add cs-mask
bun add cs-mask
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2020-04-26 |
| First published | 2020-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Cosmo Guedes |
| Maintainers | ions |
| Keywords | mask, typescript, react, angular |

## Links

- npm: https://www.npmjs.com/package/cs-mask
- Repository: https://github.com/cosmoneto1/-lib-mask
- Homepage: https://github.com/cosmoneto1/-lib-mask#readme
- Issues: https://github.com/cosmoneto1/-lib-mask/issues
- npm.io page: https://npm.io/package/cs-mask

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2020-04-26
- 0.0.1 — 2020-04-26

## README

> cs-mask

## Install

```
npm install cs-mask

yarn add cs-mask
```

## Usage

```js
const maskLib = require('cs-mask');

const valueMask = maskLib.Mask(1233, '9-99-0');
console.log(valueMask);

const valueNotMask = maskLib.UnMask(valueMask);
console.log(valueNotMask);
```

```js
import { Mask, UnMask } from 'cs-mask';
const patterns = ['999.999.999-99', '99.999.999/9999-99'];

Mask('12345678901', patterns);
// 123.456.789-01
Mask('12345678000106', patterns);
// 12.345.678/0001-06
```

### Patterns:

| Code  | Significado      |
| ----- | ---------------- |
| **9** | Números (0 a 9)  |
| **A** | Letras (A a Z)   |
| **S** | Números e letras |

## License

MIT © Cosmo Guedes

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