# js-text-mask
> mask on clear js, which you can use on frontend and backend, on string or dom element
[](https://www.npmjs.com/package/js-text-mask)
[](https://www.jsdelivr.com/package/npm/js-text-mask)
## Table of Contents
- [Quick start](#quick-start)
- [Install](#install)
- [Initialization](#initialization)
- [Methods](#methods)
- [unmask](#unmask)
- [mask](#mask)
## Quick start
### Install
We support all platforms.
#### npm
For module bundlers such as Webpack or Browserify.
```shell
npm i js-text-mask
```
#### Include with <script>
1. Download lib
2. Add script to html
```html
```
##### CDN
Recommended for learning purposes, you can use the latest version:
```html
```
Recommended for production for avoiding unexpected breakage from newer versions:
```html
```
### Demo
see demo
## Methods
### unmask
will clean text from mask, and return clear value
#### Params
- `maskedText`
- Type: `string`
- Description: text for mask
- `maskSettings`
- Type: `maskSettingsProps`
- Description: setting for covering mask
#### Returns
- `string`
### mask
covering value to mask, relative settings
#### Params
- `textForMaskInput`
- Type: `string`
- Description: text for mask
- `maskSettings`
- Type: `maskSettingsProps`
- Description: setting for covering mask
#### Returns
- `string`
## Author
webster6667