@sankhyalabs/core-docs 5.20.0-dev.4 → 5.20.0-dev.6

package/classes/{MaskFormatter-1.md → MaskFormatter.md}

@@ -1,4 +1,8 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / MaskFormatter
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / MaskFormatter
 
 # Class: MaskFormatter
 
@@ -46,54 +50,21 @@ resultaria na string '123-____'.
 |PLACA (veículo) |UUU-####          |abc1234       |ABC-1234          |
 |Cor RGB         |'#AAAAAA          |00000F0       |#0000F0           |
 
-## Table of contents
-
-### Constructors
-
-- [constructor](MaskFormatter-1.md#constructor)
-
-### Properties
-
-- [\_mask](MaskFormatter-1.md#_mask)
-- [\_maskChars](MaskFormatter-1.md#_maskchars)
-- [placeholder](MaskFormatter-1.md#placeholder)
-- [ALPHA\_NUMERIC\_KEY](MaskFormatter-1.md#alpha_numeric_key)
-- [ANYTHING\_KEY](MaskFormatter-1.md#anything_key)
-- [AlphaNumericCharacter](MaskFormatter-1.md#alphanumericcharacter)
-- [CHARACTER\_KEY](MaskFormatter-1.md#character_key)
-- [CharCharacter](MaskFormatter-1.md#charcharacter)
-- [DEFAULT\_MASKS](MaskFormatter-1.md#default_masks)
-- [DIGIT\_KEY](MaskFormatter-1.md#digit_key)
-- [DigitMaskCharacter](MaskFormatter-1.md#digitmaskcharacter)
-- [LITERAL\_KEY](MaskFormatter-1.md#literal_key)
-- [LOWERCASE\_KEY](MaskFormatter-1.md#lowercase_key)
-- [LiteralCharacter](MaskFormatter-1.md#literalcharacter)
-- [LowerCaseCharacter](MaskFormatter-1.md#lowercasecharacter)
-- [UPPERCASE\_KEY](MaskFormatter-1.md#uppercase_key)
-- [UpperCaseCharacter](MaskFormatter-1.md#uppercasecharacter)
-
-### Accessors
-
-- [mask](MaskFormatter-1.md#mask)
-
-### Methods
-
-- [format](MaskFormatter-1.md#format)
-- [updateInternalMask](MaskFormatter-1.md#updateinternalmask)
-
 ## Constructors
 
-### constructor
+### new MaskFormatter()
 
-• **new MaskFormatter**(`mask`)
+> **new MaskFormatter**(`mask`): [`MaskFormatter`](MaskFormatter.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `mask` | `string` |
+• **mask**: `string`
 
-#### Defined in
+#### Returns
+
+[`MaskFormatter`](MaskFormatter.md)
+
+#### Source
 
 src/utils/MaskFormatter.ts:91
 
@@ -101,172 +72,172 @@ src/utils/MaskFormatter.ts:91
 
 ### \_mask
 
-• `Private` **\_mask**: `string` = `''`
+> `private` **\_mask**: `string` = `''`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:65
 
-___
+***
 
 ### \_maskChars
 
-• `Private` **\_maskChars**: `__class`[]
+> `private` **\_maskChars**: `__class`[]
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:66
 
-___
+***
 
 ### placeholder
 
-• **placeholder**: `string` = `' '`
+> **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.
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:72
 
-___
+***
 
 ### ALPHA\_NUMERIC\_KEY
 
-▪ `Static` `Private` **ALPHA\_NUMERIC\_KEY**: `string` = `"A"`
+> `static` `private` **ALPHA\_NUMERIC\_KEY**: `string` = `"A"`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:53
 
-___
+***
 
 ### ANYTHING\_KEY
 
-▪ `Static` `Private` **ANYTHING\_KEY**: `string` = `"*"`
+> `static` `private` **ANYTHING\_KEY**: `string` = `"*"`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:55
 
-___
+***
 
 ### AlphaNumericCharacter
 
-▪ `Static` `Private` **AlphaNumericCharacter**: typeof `__class`
+> `static` `private` **AlphaNumericCharacter**: *typeof* `__class`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:375
 
-___
+***
 
 ### CHARACTER\_KEY
 
-▪ `Static` `Private` **CHARACTER\_KEY**: `string` = `"?"`
+> `static` `private` **CHARACTER\_KEY**: `string` = `"?"`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:54
 
-___
+***
 
 ### CharCharacter
 
-▪ `Static` `Private` **CharCharacter**: typeof `__class`
+> `static` `private` **CharCharacter**: *typeof* `__class`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:389
 
-___
+***
 
 ### DEFAULT\_MASKS
 
-▪ `Static` **DEFAULT\_MASKS**: `any`
+> `static` **DEFAULT\_MASKS**: `any`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:57
 
-___
+***
 
 ### DIGIT\_KEY
 
-▪ `Static` `Private` **DIGIT\_KEY**: `string` = `"#"`
+> `static` `private` **DIGIT\_KEY**: `string` = `"#"`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:49
 
-___
+***
 
 ### DigitMaskCharacter
 
-▪ `Static` `Private` **DigitMaskCharacter**: typeof `__class`
+> `static` `private` **DigitMaskCharacter**: *typeof* `__class`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:300
 
-___
+***
 
 ### LITERAL\_KEY
 
-▪ `Static` `Private` **LITERAL\_KEY**: `string` = `"'"`
+> `static` `private` **LITERAL\_KEY**: `string` = `"'"`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:50
 
-___
+***
 
 ### LOWERCASE\_KEY
 
-▪ `Static` `Private` **LOWERCASE\_KEY**: `string` = `"L"`
+> `static` `private` **LOWERCASE\_KEY**: `string` = `"L"`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:52
 
-___
+***
 
 ### LiteralCharacter
 
-▪ `Static` `Private` **LiteralCharacter**: typeof `__class`
+> `static` `private` **LiteralCharacter**: *typeof* `__class`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:281
 
-___
+***
 
 ### LowerCaseCharacter
 
-▪ `Static` `Private` **LowerCaseCharacter**: typeof `__class`
+> `static` `private` **LowerCaseCharacter**: *typeof* `__class`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:352
 
-___
+***
 
 ### UPPERCASE\_KEY
 
-▪ `Static` `Private` **UPPERCASE\_KEY**: `string` = `"U"`
+> `static` `private` **UPPERCASE\_KEY**: `string` = `"U"`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:51
 
-___
+***
 
 ### UpperCaseCharacter
 
-▪ `Static` `Private` **UpperCaseCharacter**: typeof `__class`
+> `static` `private` **UpperCaseCharacter**: *typeof* `__class`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:329
 
@@ -274,51 +245,41 @@ src/utils/MaskFormatter.ts:329
 
 ### mask
 
-• `get` **mask**(): `string`
+> `get` **mask**(): `string`
 
 Getter para mask.
 
-#### Returns
-
-`string`
-
-A última máscara informada.
-
-#### Defined in
-
-src/utils/MaskFormatter.ts:87
-
-• `set` **mask**(`mask`): `void`
+> `set` **mask**(`mask`): `void`
 
 Setter para mask. Trata-se do padrão que se espera ao formatar o texto.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `mask` | `string` |
+• **mask**: `string`
 
 #### Returns
 
-`void`
+`string`
 
-#### Defined in
+A última máscara informada.
 
-src/utils/MaskFormatter.ts:77
+#### Source
+
+src/utils/MaskFormatter.ts:87
 
 ## Methods
 
-### format
+### format()
 
-▸ **format**(`value`): `string`
+> **format**(`value`): `string`
 
 Formata a string passada baseada na máscara definda pelo atributo mask.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `string` | Valor a ser formatado. |
+• **value**: `string`
+
+Valor a ser formatado.
 
 #### Returns
 
@@ -326,15 +287,15 @@ Formata a string passada baseada na máscara definda pelo atributo mask.
 
 O valor processado de acordo com o padrão.
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:101
 
-___
+***
 
-### updateInternalMask
+### updateInternalMask()
 
-▸ `Private` **updateInternalMask**(): `void`
+> `private` **updateInternalMask**(): `void`
 
 Prepara a formatação internamente de acordo com o padrão.
 
@@ -342,6 +303,6 @@ Prepara a formatação internamente de acordo com o padrão.
 
 `void`
 
-#### Defined in
+#### Source
 
 src/utils/MaskFormatter.ts:118