[**@sankhyalabs/core**](../README.md) • **Docs**

***

[@sankhyalabs/core](../globals.md) / MaskFormatter

# Class: MaskFormatter

`MaskFormatter` é usado para formatar strings. Seu comportamento
é controlado pelo formato do atributo `mask` que especifica quais
caracteres são válidos e onde devem estar posicionados, intercalando-os
com eventuais caracteres literais expressados no padrão informado.
Sua implementação é inspirada pela implementação em Java do [MaskFormatter](https://docs.oracle.com/javase/7/docs/api/javax/swing/text/MaskFormatter.html).

Para o padrão da máscara podem ser usados os seguintes caracteres especiais:

| Caractere | Comportamento                                                                                               |
|:---------:|-------------------------------------------------------------------------------------------------------------|
| #         | Qualquer número                                                                                             |
| '         | "Escapa" o caractere que vem na sequência. Útil quando desejamos converter um caractere especial em literal.|
| U         | Qualquer letra. Transforma letras minúsculas em maiúsculas.                                                 |
| L         | Qualquer letra. Transforma letras maiúsculas em minúsculas.                                                 |
| A         | Qualquer letra ou número.                                                                                   |
| Z         | Qualquer letra ou número. Transforma letras minúsculas em maiúsculas.                                       |
| ?         | Qualquer letra. Preserva maiúsculas e minúsculas.                                                           |
| *         | Qualquer caractere.                                                                                         |

Os demais caracteres presentes no padrão serão tratados como literais, isto é,
serão apenas inseridos naquela posição.

Quando o valor a ser formatado é menor que a máscara, um 'placeHolder'
será inserido em cada posição ausente, completando a formatação.
Por padrão será usado um espaço em branco como 'placeHolder', mas
esse valor pode ser alterado.

Por exemplo:
'''
   const formatter: MaskFormatter = new MaskFormatter("###-####");
   formatter.placeholder = '_';
   console.log(formatter.format("123"));
'''
resultaria na string '123-____'.

##Veja mais alguns exemplos:
|Padrão          |Máscara           |Entrada       |Saída              |
|----------------|------------------|--------------|-------------------|
|Telefone        |(##) ####-####    |3432192515    |(34) 3219-2515     |
|CPF             |###.###.###-##    |12345678901   |123.456.789-01     |
|CNPJ            |ZZ.ZZZ.ZZZ/ZZZZ-##|1a3B5c7D9e1F31|1A.3B5.C7D9/E1F3-31|
|CEP             |##.###-###        |12345678      |12.345-678         |
|PLACA (veículo) |UUU-####          |abc1234       |ABC-1234           |
|Cor RGB         |'#AAAAAA        |00000F0       |#0000F0            |

## Constructors

### new MaskFormatter()

> **new MaskFormatter**(`mask`): [`MaskFormatter`](MaskFormatter.md)

#### Parameters

• **mask**: `string`

#### Returns

[`MaskFormatter`](MaskFormatter.md)

#### Source

src/utils/MaskFormatter.ts:94

## Properties

### \_mask

> `private` **\_mask**: `string` = `''`

#### Source

src/utils/MaskFormatter.ts:68

***

### \_maskChars

> `private` **\_maskChars**: `__class`[]

#### Source

src/utils/MaskFormatter.ts:69

***

### placeholder

> **placeholder**: `string` = `' '`

Determina qual caractere será usado dos caracteres não presentes no valor,
ou seja, aqueles que o usuário ainda não informou. Por padrão usamos um espaço.

#### Source

src/utils/MaskFormatter.ts:75

***

### ALPHA\_NUMERIC\_KEY

> `static` `private` **ALPHA\_NUMERIC\_KEY**: `string` = `"A"`

#### Source

src/utils/MaskFormatter.ts:54

***

### ALPHA\_NUMERIC\_UPPERCASE\_KEY

> `static` `private` **ALPHA\_NUMERIC\_UPPERCASE\_KEY**: `string` = `"Z"`

#### Source

src/utils/MaskFormatter.ts:55

***

### ANYTHING\_KEY

> `static` `private` **ANYTHING\_KEY**: `string` = `"*"`

#### Source

src/utils/MaskFormatter.ts:57

***

### AlphaNumericCharacter

> `static` `private` **AlphaNumericCharacter**: *typeof* `__class`

#### Source

src/utils/MaskFormatter.ts:474

***

### AlphaNumericUpperCaseCharacter

> `static` `private` **AlphaNumericUpperCaseCharacter**: *typeof* `__class`

#### Source

src/utils/MaskFormatter.ts:488

***

### CHARACTER\_KEY

> `static` `private` **CHARACTER\_KEY**: `string` = `"?"`

#### Source

src/utils/MaskFormatter.ts:56

***

### CharCharacter

> `static` `private` **CharCharacter**: *typeof* `__class`

#### Source

src/utils/MaskFormatter.ts:506

***

### DEFAULT\_MASKS

> `static` **DEFAULT\_MASKS**: `any`

#### Source

src/utils/MaskFormatter.ts:59

***

### DIGIT\_KEY

> `static` `private` **DIGIT\_KEY**: `string` = `"#"`

#### Source

src/utils/MaskFormatter.ts:50

***

### DigitMaskCharacter

> `static` `private` **DigitMaskCharacter**: *typeof* `__class`

#### Source

src/utils/MaskFormatter.ts:399

***

### LITERAL\_KEY

> `static` `private` **LITERAL\_KEY**: `string` = `"'"`

#### Source

src/utils/MaskFormatter.ts:51

***

### LOWERCASE\_KEY

> `static` `private` **LOWERCASE\_KEY**: `string` = `"L"`

#### Source

src/utils/MaskFormatter.ts:53

***

### LiteralCharacter

> `static` `private` **LiteralCharacter**: *typeof* `__class`

#### Source

src/utils/MaskFormatter.ts:380

***

### LowerCaseCharacter

> `static` `private` **LowerCaseCharacter**: *typeof* `__class`

#### Source

src/utils/MaskFormatter.ts:451

***

### UPPERCASE\_KEY

> `static` `private` **UPPERCASE\_KEY**: `string` = `"U"`

#### Source

src/utils/MaskFormatter.ts:52

***

### UpperCaseCharacter

> `static` `private` **UpperCaseCharacter**: *typeof* `__class`

#### Source

src/utils/MaskFormatter.ts:428

## Accessors

### mask

> `get` **mask**(): `string`

Getter para mask.

> `set` **mask**(`mask`): `void`

Setter para mask. Trata-se do padrão que se espera ao formatar o texto.

#### Parameters

• **mask**: `string`

#### Returns

`string`

A última máscara informada.

#### Source

src/utils/MaskFormatter.ts:90

## Methods

### applyMask()

> **applyMask**(`value`): `string`

Aplica a máscara quando o input é alterado

#### Parameters

• **value**: `string`

Valor a ser aplicado com a máscara.

#### Returns

`string`

O valor processado de acordo com o padrão.

#### Source

src/utils/MaskFormatter.ts:105

***

### format()

> **format**(`value`, `trimBefore`): `string`

Formata a string passada baseada na máscara definda pelo atributo mask.

#### Parameters

• **value**: `string`

Valor a ser formatado.

• **trimBefore**: `boolean`= `false`

Executa um trim para remover espaços em branco.

#### Returns

`string`

O valor processado de acordo com o padrão.

#### Source

src/utils/MaskFormatter.ts:193

***

### removeMask()

> **removeMask**(`value`): `string`

Remove a máscara formatando a string retornando sem máscara

#### Parameters

• **value**: `string`

Valor a ser formatado com máscara.

#### Returns

`string`

O valor processado de acordo com o padrão.

#### Source

src/utils/MaskFormatter.ts:173

***

### updateInternalMask()

> `private` **updateInternalMask**(): `void`

Prepara a formatação internamente de acordo com o padrão.

#### Returns

`void`

#### Source

src/utils/MaskFormatter.ts:213