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

package/enumerations/OverflowDirection.md

@@ -0,0 +1,29 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OverflowDirection
+
+# Enumeration: OverflowDirection
+
+Define em qual direção o overflow será observado
+
+## Enumeration Members
+
+### HORIZONTAL
+
+> **HORIZONTAL**: `1`
+
+#### Source
+
+src/utils/OverflowWatcher/types/overflow-direction.ts:6
+
+***
+
+### VERTICAL
+
+> **VERTICAL**: `0`
+
+#### Source
+
+src/utils/OverflowWatcher/types/overflow-direction.ts:5

package/enumerations/SelectionMode.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1902
+src/dataunit/DataUnit.ts:2022
 
 ***
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1902
 
 #### Source
 
-src/dataunit/DataUnit.ts:1903
+src/dataunit/DataUnit.ts:2023

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

@@ -14,8 +14,11 @@
 - [ChangeOperation](enumerations/ChangeOperation.md)
 - [DataType](enumerations/DataType.md)
 - [DependencyType](enumerations/DependencyType.md)
+- [LockManagerOperation](enumerations/LockManagerOperation.md)
+- [OverflowDirection](enumerations/OverflowDirection.md)
 - [SelectionMode](enumerations/SelectionMode.md)
 - [SortMode](enumerations/SortMode.md)
+- [StorageType](enumerations/StorageType.md)
 - [UserInterface](enumerations/UserInterface.md)
 
 ## Classes
@@ -38,15 +41,20 @@
 - [IDBRepository](classes/IDBRepository.md)
 - [JSUtils](classes/JSUtils.md)
 - [KeyboardManager](classes/KeyboardManager.md)
+- [LockManager](classes/LockManager.md)
 - [MaskFormatter](classes/MaskFormatter.md)
 - [NumberUtils](classes/NumberUtils.md)
 - [ObjectUtils](classes/ObjectUtils.md)
 - [OnboardingUtils](classes/OnboardingUtils.md)
+- [OverflowWatcher](classes/OverflowWatcher.md)
 - [PromiseSync](classes/PromiseSync.md)
 - [ReadyUtil](classes/ReadyUtil.md)
 - [RequestMetadata](classes/RequestMetadata.md)
 - [SearchUtils](classes/SearchUtils.md)
 - [SelectionInfo](classes/SelectionInfo.md)
+- [ServiceCanceledException](classes/ServiceCanceledException.md)
+- [ServiceUtils](classes/ServiceUtils.md)
+- [SilentException](classes/SilentException.md)
 - [SkwHttpProvider](classes/SkwHttpProvider.md)
 - [StringUtils](classes/StringUtils.md)
 - [TimeFormatter](classes/TimeFormatter.md)
@@ -69,6 +77,7 @@
 - [IRepositoryIndex](interfaces/IRepositoryIndex.md)
 - [LoadDataRequest](interfaces/LoadDataRequest.md)
 - [LoadDataResponse](interfaces/LoadDataResponse.md)
+- [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
 - [PageRequest](interfaces/PageRequest.md)
 - [PaginationInfo](interfaces/PaginationInfo.md)
 - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
@@ -80,6 +89,15 @@
 - [UnitMetadata](interfaces/UnitMetadata.md)
 - [WaitingChange](interfaces/WaitingChange.md)
 
+## Type Aliases
+
+- [DataUnitEventOptions](type-aliases/DataUnitEventOptions.md)
+- [OnOverflowCallBack](type-aliases/OnOverflowCallBack.md)
+
+## Variables
+
+- [OVERFLOWED\_CLASS\_NAME](variables/OVERFLOWED_CLASS_NAME.md)
+
 ## Functions
 
 - [defaultDataLoader](functions/defaultDataLoader.md)

package/interfaces/DUActionInterceptor.md

@@ -22,4 +22,4 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1777
+src/dataunit/DataUnit.ts:1897

package/interfaces/IRepository.md

@@ -96,6 +96,24 @@ src/repository/IRepository.ts:23
 
 ***
 
+### getFromCache()
+
+> **getFromCache**(): `undefined` \| `T`[]
+
+Retorna todos os registros que estão em cache no momento
+
+#### Returns
+
+`undefined` \| `T`[]
+
+Todos registros que estão em cache no momento
+
+#### Source
+
+src/repository/IRepository.ts:88
+
+***
+
 ### insert()
 
 > **insert**(`itemReference`, `items`): `Promise`\<`void`\>

package/interfaces/LoadDataRequest.md

@@ -96,7 +96,7 @@ src/dataunit/loading/LoadDataRequest.ts:22
 
 ### source?
 
-> `optional` **source**: `String`
+> `optional` **source**: `string`
 
 De onde partiu o refresh. Por padrão a fonte não é identificada
 

package/interfaces/OverFlowWatcherParams.md

@@ -0,0 +1,67 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OverFlowWatcherParams
+
+# Interface: OverFlowWatcherParams
+
+## Properties
+
+### callback
+
+> **callback**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:233
+
+***
+
+### debounce?
+
+> `optional` **debounce**: `number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:236
+
+***
+
+### deltaSize?
+
+> `optional` **deltaSize**: `number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:235
+
+***
+
+### element
+
+> **element**: `HTMLElement`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:232
+
+***
+
+### notOverFlow?
+
+> `optional` **notOverFlow**: `string`[]
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:237
+
+***
+
+### overFlowDirection?
+
+> `optional` **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:234

package/interfaces/PageRequest.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1882
+src/dataunit/DataUnit.ts:2002
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1882
 
 #### Source
 
-src/dataunit/DataUnit.ts:1883
+src/dataunit/DataUnit.ts:2003
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1883
 
 #### Source
 
-src/dataunit/DataUnit.ts:1884
+src/dataunit/DataUnit.ts:2004

package/interfaces/PaginationInfo.md

@@ -70,6 +70,19 @@ src/dataunit/loading/PaginationInfo.ts:11
 
 ***
 
+### loadingInProgress?
+
+> `optional` **loadingInProgress**: `boolean`
+
+Informa se o carregamento de dados em background está sendo executado
+ Caso o dataunit não tenha carga paralela o valor será indefinido
+
+#### Source
+
+src/dataunit/loading/PaginationInfo.ts:25
+
+***
+
 ### total?
 
 > `optional` **total**: `number`

package/interfaces/QuickFilter.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1889
+src/dataunit/DataUnit.ts:2009
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1889
 
 #### Source
 
-src/dataunit/DataUnit.ts:1890
+src/dataunit/DataUnit.ts:2010
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1890
 
 #### Source
 
-src/dataunit/DataUnit.ts:1888
+src/dataunit/DataUnit.ts:2008

package/interfaces/Record.md

@@ -22,7 +22,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1784
+src/dataunit/DataUnit.ts:1904
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1784
 
 #### Source
 
-src/dataunit/DataUnit.ts:1783
+src/dataunit/DataUnit.ts:1903
 
 ***
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1783
 
 #### Source
 
-src/dataunit/DataUnit.ts:1781
+src/dataunit/DataUnit.ts:1901
 
 ***
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1781
 
 #### Source
 
-src/dataunit/DataUnit.ts:1782
+src/dataunit/DataUnit.ts:1902

package/interfaces/SavedRecord.md

@@ -18,7 +18,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1789
+src/dataunit/DataUnit.ts:1909
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1789
 
 #### Source
 
-src/dataunit/DataUnit.ts:1784
+src/dataunit/DataUnit.ts:1904
 
 ***
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1784
 
 #### Source
 
-src/dataunit/DataUnit.ts:1783
+src/dataunit/DataUnit.ts:1903
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1783
 
 #### Source
 
-src/dataunit/DataUnit.ts:1781
+src/dataunit/DataUnit.ts:1901
 
 ***
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1781
 
 #### Source
 
-src/dataunit/DataUnit.ts:1782
+src/dataunit/DataUnit.ts:1902

package/interfaces/WaitingChange.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1877
+src/dataunit/DataUnit.ts:1997
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1877
 
 #### Source
 
-src/dataunit/DataUnit.ts:1878
+src/dataunit/DataUnit.ts:1998
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1878
 
 #### Source
 
-src/dataunit/DataUnit.ts:1876
+src/dataunit/DataUnit.ts:1996

package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md

@@ -10,4 +10,4 @@
 
 ## Source
 
-src/utils/MaskFormatter.ts:166
+src/utils/MaskFormatter.ts:257

package/namespaces/MaskFormatter/variables/MaskCharacter.md

@@ -10,4 +10,4 @@
 
 ## Source
 
-src/utils/MaskFormatter.ts:166
+src/utils/MaskFormatter.ts:257

package/package.json

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

package/type-aliases/DataUnitEventOptions.md

@@ -0,0 +1,17 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DataUnitEventOptions
+
+# Type alias: DataUnitEventOptions
+
+> **DataUnitEventOptions**: `object`
+
+## Index signature
+
+ \[`key`: `string`\]: `any`
+
+## Source
+
+src/dataunit/DataUnit.ts:2079

package/type-aliases/OnOverflowCallBack.md

@@ -0,0 +1,25 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OnOverflowCallBack
+
+# Type alias: OnOverflowCallBack()
+
+> **OnOverflowCallBack**: (`elementsOverFlow`) => `void`
+
+Callback que será chamado quando o overflow de um elemento for alterado.
+
+## Parameters
+
+• **elementsOverFlow**: `Element`[]
+
+Conjunto de elementos filhos que estão causando overflow no elemento pai.
+
+## Returns
+
+`void`
+
+## Source
+
+src/utils/OverflowWatcher/types/overflow-callback.ts:6

package/variables/OVERFLOWED_CLASS_NAME.md

@@ -0,0 +1,13 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OVERFLOWED\_CLASS\_NAME
+
+# Variable: OVERFLOWED\_CLASS\_NAME
+
+> `const` **OVERFLOWED\_CLASS\_NAME**: `"overflowed"` = `'overflowed'`
+
+## Source
+
+src/utils/OverflowWatcher/index.ts:9