@sankhyalabs/core-docs 0.0.0-feat-dev-kb-66970.1 → 0.0.0-feat-dev-KB-75149.1

package/classes/Change.md

@@ -32,7 +32,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1924
+src/dataunit/DataUnit.ts:1923
 
 ## Properties
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1924
 
 #### Source
 
-src/dataunit/DataUnit.ts:1922
+src/dataunit/DataUnit.ts:1921
 
 ***
 
@@ -52,7 +52,7 @@ src/dataunit/DataUnit.ts:1922
 
 #### Source
 
-src/dataunit/DataUnit.ts:1917
+src/dataunit/DataUnit.ts:1916
 
 ***
 
@@ -62,7 +62,7 @@ src/dataunit/DataUnit.ts:1917
 
 #### Source
 
-src/dataunit/DataUnit.ts:1918
+src/dataunit/DataUnit.ts:1917
 
 ***
 
@@ -72,7 +72,7 @@ src/dataunit/DataUnit.ts:1918
 
 #### Source
 
-src/dataunit/DataUnit.ts:1919
+src/dataunit/DataUnit.ts:1918
 
 ***
 
@@ -82,7 +82,7 @@ src/dataunit/DataUnit.ts:1919
 
 #### Source
 
-src/dataunit/DataUnit.ts:1920
+src/dataunit/DataUnit.ts:1919
 
 ## Accessors
 
@@ -100,7 +100,7 @@ Obtém o tipo de operação que está sendo realizada.
 
 #### Source
 
-src/dataunit/DataUnit.ts:1939
+src/dataunit/DataUnit.ts:1938
 
 ## Methods
 
@@ -118,7 +118,7 @@ Retorna se o DataUnit está em uma operação de cópia.
 
 #### Source
 
-src/dataunit/DataUnit.ts:1961
+src/dataunit/DataUnit.ts:1960
 
 ***
 
@@ -136,7 +136,7 @@ Retorna se o DataUnit está em uma operação de deleção.
 
 #### Source
 
-src/dataunit/DataUnit.ts:1972
+src/dataunit/DataUnit.ts:1971
 
 ***
 
@@ -154,7 +154,7 @@ Retorna se o DataUnit está em uma operação de inserção.
 
 #### Source
 
-src/dataunit/DataUnit.ts:1950
+src/dataunit/DataUnit.ts:1949
 
 ***
 
@@ -172,4 +172,4 @@ Retorna se o DataUnit está em uma operação de atualização.
 
 #### Source
 
-src/dataunit/DataUnit.ts:1983
+src/dataunit/DataUnit.ts:1982

package/classes/DataUnit.md

@@ -336,7 +336,7 @@ src/dataunit/DataUnit.ts:39
 
 #### Source
 
-src/dataunit/DataUnit.ts:1876
+src/dataunit/DataUnit.ts:1875
 
 ***
 
@@ -504,7 +504,7 @@ Campo a ser adicionado.
 
 #### Source
 
-src/dataunit/DataUnit.ts:1857
+src/dataunit/DataUnit.ts:1856
 
 ***
 
@@ -594,7 +594,7 @@ Retorna uma função responsável por liberar o lock adicionado.
 
 #### Source
 
-src/dataunit/DataUnit.ts:1866
+src/dataunit/DataUnit.ts:1865
 
 ***
 
@@ -636,7 +636,7 @@ Adiciona um campo stand-alone ao dataUnit.
 
 #### Source
 
-src/dataunit/DataUnit.ts:1848
+src/dataunit/DataUnit.ts:1847
 
 ***
 
@@ -1443,7 +1443,7 @@ método foi descontinuado e pode retornar erros no caso da seleção virtual.
 
 #### Source
 
-src/dataunit/DataUnit.ts:1805
+src/dataunit/DataUnit.ts:1804
 
 ***
 
@@ -1467,7 +1467,7 @@ método foi descontinuado e pode retornar erros no caso da seleção virtual.
 
 #### Source
 
-src/dataunit/DataUnit.ts:1829
+src/dataunit/DataUnit.ts:1828
 
 ***
 
@@ -1645,7 +1645,7 @@ src/dataunit/DataUnit.ts:1104
 
 ### hideField()
 
-> **hideField**(`fieldName`, `options`): `void`
+> **hideField**(`fieldName`): `void`
 
 Deixa um campo do DataUnit invisível
 
@@ -1655,8 +1655,6 @@ Deixa um campo do DataUnit invisível
 
 nome do campo para ficar invisível.
 
-• **options**: `HideFieldOptions`
-
 #### Returns
 
 `void`
@@ -1993,7 +1991,7 @@ src/dataunit/DataUnit.ts:1294
 
 #### Source
 
-src/dataunit/DataUnit.ts:1880
+src/dataunit/DataUnit.ts:1879
 
 ***
 
@@ -2476,7 +2474,7 @@ nome do campo para ficar visível.
 
 #### Source
 
-src/dataunit/DataUnit.ts:1785
+src/dataunit/DataUnit.ts:1784
 
 ***
 

package/classes/SelectionInfo.md

@@ -30,7 +30,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:2028
+src/dataunit/DataUnit.ts:2027
 
 ## Properties
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2028
 
 #### Source
 
-src/dataunit/DataUnit.ts:2025
+src/dataunit/DataUnit.ts:2024
 
 ***
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2025
 
 #### Source
 
-src/dataunit/DataUnit.ts:2026
+src/dataunit/DataUnit.ts:2025
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2026
 
 #### Source
 
-src/dataunit/DataUnit.ts:2022
+src/dataunit/DataUnit.ts:2021
 
 ***
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:2022
 
 #### Source
 
-src/dataunit/DataUnit.ts:2024
+src/dataunit/DataUnit.ts:2023
 
 ***
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2024
 
 #### Source
 
-src/dataunit/DataUnit.ts:2021
+src/dataunit/DataUnit.ts:2020
 
 ***
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2021
 
 #### Source
 
-src/dataunit/DataUnit.ts:2023
+src/dataunit/DataUnit.ts:2022
 
 ## Accessors
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2023
 
 #### Source
 
-src/dataunit/DataUnit.ts:2056
+src/dataunit/DataUnit.ts:2055
 
 ***
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2056
 
 #### Source
 
-src/dataunit/DataUnit.ts:2046
+src/dataunit/DataUnit.ts:2045
 
 ***
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:2046
 
 #### Source
 
-src/dataunit/DataUnit.ts:2036
+src/dataunit/DataUnit.ts:2035
 
 ## Methods
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2036
 
 #### Source
 
-src/dataunit/DataUnit.ts:2063
+src/dataunit/DataUnit.ts:2062
 
 ***
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2063
 
 #### Source
 
-src/dataunit/DataUnit.ts:2067
+src/dataunit/DataUnit.ts:2066

package/classes/ServiceUtils.md

@@ -0,0 +1,67 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / ServiceUtils
+
+# Class: ServiceUtils
+
+## Constructors
+
+### new ServiceUtils()
+
+> **new ServiceUtils**(): [`ServiceUtils`](ServiceUtils.md)
+
+#### Returns
+
+[`ServiceUtils`](ServiceUtils.md)
+
+## Methods
+
+### useCacheWithService()
+
+> `static` **useCacheWithService**\<`T`\>(`identifier`, `fetchFunction`, `storageType`): `Promise`\<`T`\>
+
+Auxilia no uso do CacheManager, gerando automaticamente uma chave de cache com base no identificador.
+
+#### Type parameters
+
+• **T**
+
+Tipo do dado a ser retornado.
+
+#### Parameters
+
+• **identifier**: `string`
+
+Identificadores únicos usados para compor a chave de cache.
+
+• **fetchFunction**
+
+Função que retorna uma `Promise` com o valor a ser armazenado no cache caso ele não exista ou tenha expirado.
+
+• **storageType**: [`StorageType`](../enumerations/StorageType.md)= `StorageType.IN_MEMORY_CACHE`
+
+Tipo de armazenamento: `'sessionStorage'` ou `'localStorage'`. O padrão é `'sessionStorage'`.
+
+#### Returns
+
+`Promise`\<`T`\>
+
+Uma `Promise` com o valor armazenado ou obtido via `fetchFunction`.
+
+#### Example
+
+```typescript
+const actions = await useCacheWithService(
+ `${this.entityName} - ${this.resourceID}`,
+  async () => {
+    return await fetchActionsFromAPI();
+  }
+);
+console.log(actions);
+```
+
+#### Source
+
+src/utils/ServiceUtils.ts:28

package/enumerations/ChangeOperation.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1907
+src/dataunit/DataUnit.ts:1906
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1907
 
 #### Source
 
-src/dataunit/DataUnit.ts:1909
+src/dataunit/DataUnit.ts:1908
 
 ***
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1909
 
 #### Source
 
-src/dataunit/DataUnit.ts:1906
+src/dataunit/DataUnit.ts:1905
 
 ***
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1906
 
 #### Source
 
-src/dataunit/DataUnit.ts:1908
+src/dataunit/DataUnit.ts:1907

package/enumerations/SelectionMode.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:2015
+src/dataunit/DataUnit.ts:2014
 
 ***
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2015
 
 #### Source
 
-src/dataunit/DataUnit.ts:2016
+src/dataunit/DataUnit.ts:2015

package/enumerations/StorageType.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / StorageType
+
+# Enumeration: StorageType
+
+## Enumeration Members
+
+### IN\_MEMORY\_CACHE
+
+> **IN\_MEMORY\_CACHE**: `"inMemoryCache"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:2
+
+***
+
+### LOCAL\_STORAGE
+
+> **LOCAL\_STORAGE**: `"localStorage"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:4
+
+***
+
+### SESSION\_STORAGE
+
+> **SESSION\_STORAGE**: `"sessionStorage"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:3

package/globals.md

@@ -17,6 +17,7 @@
 - [OverflowDirection](enumerations/OverflowDirection.md)
 - [SelectionMode](enumerations/SelectionMode.md)
 - [SortMode](enumerations/SortMode.md)
+- [StorageType](enumerations/StorageType.md)
 - [UserInterface](enumerations/UserInterface.md)
 
 ## Classes
@@ -50,6 +51,7 @@
 - [SearchUtils](classes/SearchUtils.md)
 - [SelectionInfo](classes/SelectionInfo.md)
 - [ServiceCanceledException](classes/ServiceCanceledException.md)
+- [ServiceUtils](classes/ServiceUtils.md)
 - [SkwHttpProvider](classes/SkwHttpProvider.md)
 - [StringUtils](classes/StringUtils.md)
 - [TimeFormatter](classes/TimeFormatter.md)

package/interfaces/DUActionInterceptor.md

@@ -22,4 +22,4 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1890
+src/dataunit/DataUnit.ts:1889

package/interfaces/PageRequest.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1995
+src/dataunit/DataUnit.ts:1994
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1995
 
 #### Source
 
-src/dataunit/DataUnit.ts:1996
+src/dataunit/DataUnit.ts:1995
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1996
 
 #### Source
 
-src/dataunit/DataUnit.ts:1997
+src/dataunit/DataUnit.ts:1996

package/interfaces/QuickFilter.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:2002
+src/dataunit/DataUnit.ts:2001
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2002
 
 #### Source
 
-src/dataunit/DataUnit.ts:2003
+src/dataunit/DataUnit.ts:2002
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2003
 
 #### Source
 
-src/dataunit/DataUnit.ts:2001
+src/dataunit/DataUnit.ts:2000

package/interfaces/Record.md

@@ -22,7 +22,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1897
+src/dataunit/DataUnit.ts:1896
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1897
 
 #### Source
 
-src/dataunit/DataUnit.ts:1896
+src/dataunit/DataUnit.ts:1895
 
 ***
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1896
 
 #### Source
 
-src/dataunit/DataUnit.ts:1894
+src/dataunit/DataUnit.ts:1893
 
 ***
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1894
 
 #### Source
 
-src/dataunit/DataUnit.ts:1895
+src/dataunit/DataUnit.ts:1894

package/interfaces/SavedRecord.md

@@ -18,7 +18,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1902
+src/dataunit/DataUnit.ts:1901
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1902
 
 #### Source
 
-src/dataunit/DataUnit.ts:1897
+src/dataunit/DataUnit.ts:1896
 
 ***
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1897
 
 #### Source
 
-src/dataunit/DataUnit.ts:1896
+src/dataunit/DataUnit.ts:1895
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1896
 
 #### Source
 
-src/dataunit/DataUnit.ts:1894
+src/dataunit/DataUnit.ts:1893
 
 ***
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1894
 
 #### Source
 
-src/dataunit/DataUnit.ts:1895
+src/dataunit/DataUnit.ts:1894

package/interfaces/WaitingChange.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1990
+src/dataunit/DataUnit.ts:1989
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1990
 
 #### Source
 
-src/dataunit/DataUnit.ts:1991
+src/dataunit/DataUnit.ts:1990
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1991
 
 #### Source
 
-src/dataunit/DataUnit.ts:1989
+src/dataunit/DataUnit.ts:1988

package/package.json

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

package/type-aliases/DataUnitEventOptions.md

@@ -14,4 +14,4 @@
 
 ## Source
 
-src/dataunit/DataUnit.ts:2072
+src/dataunit/DataUnit.ts:2071