@sankhyalabs/core-docs 0.0.0-feat-dev-KB-25740.0 → 0.0.0-feat-dev-KB-28409.1

package/classes/ArrayUtils.md

@@ -13,7 +13,12 @@
 ### Methods
 
 - [applyStringFilter](ArrayUtils.md#applystringfilter)
+- [find](ArrayUtils.md#find)
+- [indexOf](ArrayUtils.md#indexof)
+- [isIn](ArrayUtils.md#isin)
 - [normalizeSearchString](ArrayUtils.md#normalizesearchstring)
+- [removeAtIndex](ArrayUtils.md#removeatindex)
+- [removeReference](ArrayUtils.md#removereference)
 - [sortAlphabetically](ArrayUtils.md#sortalphabetically)
 
 ## Constructors
@@ -47,7 +52,82 @@ Filtra um array a partir de um critério textual.
 
 #### Defined in
 
-src/utils/ArrayUtils.ts:17
+src/utils/ArrayUtils.ts:18
+
+___
+
+### find
+
+▸ `Static` **find**(`arr`, `checkerFn`): `any`
+
+Ordena valores de um array alfabeticamente.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `arr` | `any` | Array a ser ordenado. |
+| `checkerFn` | `any` | - |
+
+#### Returns
+
+`any`
+
+- Array ordenado alfabeticamente..
+
+#### Defined in
+
+src/utils/ArrayUtils.ts:69
+
+___
+
+### indexOf
+
+▸ `Static` **indexOf**(`arr`, `obj`): `number`
+
+Retorna o objeto se for encontrado no array, ou -1 se não for encontrado.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `arr` | `any` | Array onde está o objeto. |
+| `obj` | `any` | Objeto a ser procurado. |
+
+#### Returns
+
+`number`
+
+- Array ordenado alfabeticamente..
+
+#### Defined in
+
+src/utils/ArrayUtils.ts:88
+
+___
+
+### isIn
+
+▸ `Static` **isIn**(`arr`, `obj`): `boolean`
+
+Remove um objeto do array.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `arr` | `any` | - |
+| `obj` | `any` | Objeto a ser removido. |
+
+#### Returns
+
+`boolean`
+
+- Array sem o Objeto informado.
+
+#### Defined in
+
+src/utils/ArrayUtils.ts:131
 
 ___
 
@@ -71,7 +151,57 @@ Converte texto para caixa alta e substitui caracteres acentuados.
 
 #### Defined in
 
-src/utils/ArrayUtils.ts:35
+src/utils/ArrayUtils.ts:36
+
+___
+
+### removeAtIndex
+
+▸ `Static` **removeAtIndex**(`array`, `index`): `any`
+
+Remove um item de array de acordo com o index.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `array` | `any` | Array onde está o item. |
+| `index` | `number` | Index do item a ser removido. |
+
+#### Returns
+
+`any`
+
+- Array sem o item do index informado.
+
+#### Defined in
+
+src/utils/ArrayUtils.ts:106
+
+___
+
+### removeReference
+
+▸ `Static` **removeReference**(`array`, `obj`): `any`
+
+Remove um objeto do array.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `array` | `any` | Array onde está o objeto. |
+| `obj` | `any` | Objeto a ser removido. |
+
+#### Returns
+
+`any`
+
+- Array sem o Objeto informado.
+
+#### Defined in
+
+src/utils/ArrayUtils.ts:119
 
 ___
 
@@ -96,4 +226,4 @@ Ordena valores de um array alfabeticamente.
 
 #### Defined in
 
-src/utils/ArrayUtils.ts:45
+src/utils/ArrayUtils.ts:46

package/classes/JSUtils.md

@@ -18,6 +18,7 @@ Classe com utiliários comuns para funções genéricas em JavaScript.
 - [isBase64](JSUtils.md#isbase64)
 - [isEllipsisActive](JSUtils.md#isellipsisactive)
 - [isHiddenElement](JSUtils.md#ishiddenelement)
+- [replaceHtmlEntities](JSUtils.md#replacehtmlentities)
 
 ## Constructors
 
@@ -161,3 +162,27 @@ ___
 #### Defined in
 
 src/utils/JSUtils.ts:8
+
+___
+
+### replaceHtmlEntities
+
+▸ `Static` **replaceHtmlEntities**(`source`): `string`
+
+Substitui caracteres para suas entidades HTML.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `source` | `string` | String a ter os caracteres substituidos. |
+
+#### Returns
+
+`string`
+
+- Retorna um UUID.
+
+#### Defined in
+
+src/utils/JSUtils.ts:105

package/classes/ObjectUtils.md

@@ -13,6 +13,7 @@
 ### Methods
 
 - [copy](ObjectUtils.md#copy)
+- [equals](ObjectUtils.md#equals)
 - [objectToString](ObjectUtils.md#objecttostring)
 - [removeEmptyValues](ObjectUtils.md#removeemptyvalues)
 - [sortByProperty](ObjectUtils.md#sortbyproperty)
@@ -56,6 +57,31 @@ src/utils/ObjectUtils.ts:13
 
 ___
 
+### equals
+
+▸ `Static` **equals**(`obj1`, `obj2`): `any`
+
+Compara se um objeto é igual a outro objeto.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `obj1` | `any` | Objeto a ser comparado. |
+| `obj2` | `any` | Objeto a ser comparado. |
+
+#### Returns
+
+`any`
+
+- Se o objeto 1 é igual ao objeto 2.
+
+#### Defined in
+
+src/utils/ObjectUtils.ts:84
+
+___
+
 ### objectToString
 
 ▸ `Static` **objectToString**(`data`): `string`

package/classes/SearchUtils.md

@@ -0,0 +1,43 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SearchUtils
+
+# Class: SearchUtils
+
+`Search`: Utilizado para manipulação de do objeto de pesquisa.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](SearchUtils.md#constructor)
+
+### Methods
+
+- [buildDetails](SearchUtils.md#builddetails)
+
+## Constructors
+
+### constructor
+
+• **new SearchUtils**()
+
+## Methods
+
+### buildDetails
+
+▸ `Static` **buildDetails**(`argument`, `fields`, `item`): `any`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `argument` | `String` |
+| `fields` | `any` |
+| `item` | `any` |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+src/utils/SearchUtils.ts:8

package/classes/StringUtils.md

@@ -16,21 +16,27 @@
 - [decodeHtmlEntities](StringUtils.md#decodehtmlentities)
 - [formatBytes](StringUtils.md#formatbytes)
 - [generateUUID](StringUtils.md#generateuuid)
+- [getArgumentNumber](StringUtils.md#getargumentnumber)
 - [getBooleanValue](StringUtils.md#getbooleanvalue)
 - [getOppositeCase](StringUtils.md#getoppositecase)
+- [getSpecialCharacters](StringUtils.md#getspecialcharacters)
 - [hashCode](StringUtils.md#hashcode)
+- [highlightValue](StringUtils.md#highlightvalue)
 - [isCaseable](StringUtils.md#iscaseable)
 - [isEmpty](StringUtils.md#isempty)
 - [isLowerCase](StringUtils.md#islowercase)
-- [isString](StringUtils.md#isstring)
 - [padEnd](StringUtils.md#padend)
 - [padStart](StringUtils.md#padstart)
 - [prettyPrecision](StringUtils.md#prettyprecision)
+- [removeSpecialCharacters](StringUtils.md#removespecialcharacters)
 - [replaceAccentuatedChars](StringUtils.md#replaceaccentuatedchars)
+- [replaceAccentuatedCharsHtmlEntities](StringUtils.md#replaceaccentuatedcharshtmlentities)
 - [replaceAccentuatedCharsKeepSymbols](StringUtils.md#replaceaccentuatedcharskeepsymbols)
 - [replaceAccentuatedCharsLower](StringUtils.md#replaceaccentuatedcharslower)
 - [replaceAccentuatedCharsUpper](StringUtils.md#replaceaccentuatedcharsupper)
+- [replaceAll](StringUtils.md#replaceall)
 - [replaceBlankCharacters](StringUtils.md#replaceblankcharacters)
+- [replaceToSpace](StringUtils.md#replacetospace)
 - [toCamelCase](StringUtils.md#tocamelcase)
 - [toKebabCase](StringUtils.md#tokebabcase)
 - [toPascalCase](StringUtils.md#topascalcase)
@@ -65,7 +71,7 @@ Determina a ordem de strings.
 
 #### Defined in
 
-src/utils/StringUtils.ts:248
+src/utils/StringUtils.ts:236
 
 ___
 
@@ -93,7 +99,7 @@ entrada: "&lt;Teste&gt;" // retorno: "<Teste>"
 
 #### Defined in
 
-src/utils/StringUtils.ts:69
+src/utils/StringUtils.ts:62
 
 ___
 
@@ -118,7 +124,7 @@ string formatada de acordo com a unidade.
 
 #### Defined in
 
-src/utils/StringUtils.ts:333
+src/utils/StringUtils.ts:321
 
 ___
 
@@ -136,7 +142,27 @@ id único randômico.
 
 #### Defined in
 
-src/utils/StringUtils.ts:379
+src/utils/StringUtils.ts:367
+
+___
+
+### getArgumentNumber
+
+▸ `Static` **getArgumentNumber**(`argument`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `argument` | `String` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+src/utils/StringUtils.ts:471
 
 ___
 
@@ -168,7 +194,7 @@ Informado: 'false' | Retorna: false
 
 #### Defined in
 
-src/utils/StringUtils.ts:178
+src/utils/StringUtils.ts:166
 
 ___
 
@@ -192,7 +218,27 @@ A string invertida
 
 #### Defined in
 
-src/utils/StringUtils.ts:414
+src/utils/StringUtils.ts:402
+
+___
+
+### getSpecialCharacters
+
+▸ `Static` **getSpecialCharacters**(`str`): `string`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `str` | `string` |
+
+#### Returns
+
+`string`[]
+
+#### Defined in
+
+src/utils/StringUtils.ts:443
 
 ___
 
@@ -222,7 +268,31 @@ Informado: '123456' | Retorna: 1450575459
 
 #### Defined in
 
-src/utils/StringUtils.ts:156
+src/utils/StringUtils.ts:145
+
+___
+
+### highlightValue
+
+▸ `Static` **highlightValue**(`argument`, `matchFields`, `value`, `fieldMD`, `forceMatch`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `argument` | `String` |
+| `matchFields` | `any` |
+| `value` | `string` |
+| `fieldMD` | `any` |
+| `forceMatch` | `boolean` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/StringUtils.ts:475
 
 ___
 
@@ -246,7 +316,7 @@ Se a string pode ser convertida
 
 #### Defined in
 
-src/utils/StringUtils.ts:389
+src/utils/StringUtils.ts:377
 
 ___
 
@@ -271,7 +341,7 @@ Valores null e undefined são considerados como vazio.
 
 #### Defined in
 
-src/utils/StringUtils.ts:16
+src/utils/StringUtils.ts:18
 
 ___
 
@@ -295,29 +365,7 @@ Se a string é minúscula
 
 #### Defined in
 
-src/utils/StringUtils.ts:402
-
-___
-
-### isString
-
-▸ `Static` **isString**(`text`): `boolean`
-
-Verifica se argumento informado é do tipo string
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `text` | `any` |
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-src/utils/StringUtils.ts:36
+src/utils/StringUtils.ts:390
 
 ___
 
@@ -356,7 +404,7 @@ Ou retorna o texto com os caracteres adicionados na direita.
 
 #### Defined in
 
-src/utils/StringUtils.ts:232
+src/utils/StringUtils.ts:220
 
 ___
 
@@ -395,7 +443,7 @@ Ou retorna o texto com os caracteres adicionados na esquerda.
 
 #### Defined in
 
-src/utils/StringUtils.ts:207
+src/utils/StringUtils.ts:195
 
 ___
 
@@ -420,7 +468,27 @@ simplificação do strNumber, sem os zeros à direita depois do ponto.
 
 #### Defined in
 
-src/utils/StringUtils.ts:358
+src/utils/StringUtils.ts:346
+
+___
+
+### removeSpecialCharacters
+
+▸ `Static` **removeSpecialCharacters**(`str`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `str` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/StringUtils.ts:462
 
 ___
 
@@ -450,7 +518,27 @@ entrada: "á@Êç#Ò", true // retorno: "aEcO"
 
 #### Defined in
 
-src/utils/StringUtils.ts:122
+src/utils/StringUtils.ts:115
+
+___
+
+### replaceAccentuatedCharsHtmlEntities
+
+▸ `Static` **replaceAccentuatedCharsHtmlEntities**(`source`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `source` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/StringUtils.ts:423
 
 ___
 
@@ -474,7 +562,7 @@ Remove acentos de vogais, substitui Ç por c e retorna a string em caixa alta ma
 
 #### Defined in
 
-src/utils/StringUtils.ts:141
+src/utils/StringUtils.ts:134
 
 ___
 
@@ -502,7 +590,7 @@ entrada: "áêçò" // retorno: "aeco"
 
 #### Defined in
 
-src/utils/StringUtils.ts:99
+src/utils/StringUtils.ts:92
 
 ___
 
@@ -530,7 +618,29 @@ entrada: "ÁÊÇÒ" // retorno: "AECO"
 
 #### Defined in
 
-src/utils/StringUtils.ts:47
+src/utils/StringUtils.ts:40
+
+___
+
+### replaceAll
+
+▸ `Static` **replaceAll**(`str`, `strFrom`, `strTo`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `str` | `string` |
+| `strFrom` | `string` |
+| `strTo` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/StringUtils.ts:453
 
 ___
 
@@ -554,7 +664,28 @@ String sem espaços em branco.
 
 #### Defined in
 
-src/utils/StringUtils.ts:323
+src/utils/StringUtils.ts:311
+
+___
+
+### replaceToSpace
+
+▸ `Static` **replaceToSpace**(`source`, `replaceList?`): `string`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `source` | `string` | `undefined` |
+| `replaceList` | `string`[] | `[]` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/StringUtils.ts:406
 
 ___
 
@@ -585,7 +716,7 @@ String convertida em camelCase.
 
 #### Defined in
 
-src/utils/StringUtils.ts:274
+src/utils/StringUtils.ts:262
 
 ___
 
@@ -609,7 +740,7 @@ String convertida em KebabCase.
 
 #### Defined in
 
-src/utils/StringUtils.ts:314
+src/utils/StringUtils.ts:302
 
 ___
 
@@ -633,7 +764,7 @@ String convertida em PascalCase.
 
 #### Defined in
 
-src/utils/StringUtils.ts:289
+src/utils/StringUtils.ts:277
 
 ___
 
@@ -657,4 +788,4 @@ String convertida em snake_case.
 
 #### Defined in
 
-src/utils/StringUtils.ts:301
+src/utils/StringUtils.ts:289

package/modules.md

@@ -45,6 +45,7 @@
 - [PromiseSync](classes/PromiseSync.md)
 - [ReadyUtil](classes/ReadyUtil.md)
 - [RequestMetadata](classes/RequestMetadata.md)
+- [SearchUtils](classes/SearchUtils.md)
 - [SelectionInfo](classes/SelectionInfo.md)
 - [SkwHttpProvider](classes/SkwHttpProvider.md)
 - [StringUtils](classes/StringUtils.md)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sankhyalabs/core-docs",
-    "version": "0.0.0-feat-dev-KB-25740.0",
+    "version": "0.0.0-feat-dev-KB-28409.1",
     "description": "Documentação da biblioteca de componentes Sankhya.",
     "main": "",
     "files": [