@sankhyalabs/core-docs 2.3.4 → 2.3.6

package/interfaces/LoadDataRequest.md

@@ -0,0 +1,63 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / LoadDataRequest
+
+# Interface: LoadDataRequest
+
+## Table of contents
+
+### Properties
+
+- [filters](LoadDataRequest.md#filters)
+- [limit](LoadDataRequest.md#limit)
+- [offset](LoadDataRequest.md#offset)
+- [quickFilter](LoadDataRequest.md#quickfilter)
+- [sort](LoadDataRequest.md#sort)
+
+## Properties
+
+### filters
+
+• `Optional` **filters**: [`Filter`](Filter.md)[]
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:8
+
+___
+
+### limit
+
+• `Optional` **limit**: `number`
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:6
+
+___
+
+### offset
+
+• `Optional` **offset**: `number`
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:5
+
+___
+
+### quickFilter
+
+• `Optional` **quickFilter**: [`QuickFilter`](QuickFilter.md)
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:7
+
+___
+
+### sort
+
+• `Optional` **sort**: [`Sort`](Sort.md)[]
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:9

package/interfaces/LoadDataResponse.md

@@ -0,0 +1,30 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / LoadDataResponse
+
+# Interface: LoadDataResponse
+
+## Table of contents
+
+### Properties
+
+- [paginationInfo](LoadDataResponse.md#paginationinfo)
+- [records](LoadDataResponse.md#records)
+
+## Properties
+
+### paginationInfo
+
+• `Optional` **paginationInfo**: [`PaginationInfo`](PaginationInfo.md)
+
+#### Defined in
+
+src/dataunit/loading/LoadDataResponse.ts:6
+
+___
+
+### records
+
+• **records**: [`Record`](Record.md)[]
+
+#### Defined in
+
+src/dataunit/loading/LoadDataResponse.ts:5

package/interfaces/PageRequest.md

@@ -0,0 +1,41 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PageRequest
+
+# Interface: PageRequest
+
+## Table of contents
+
+### Properties
+
+- [limit](PageRequest.md#limit)
+- [offset](PageRequest.md#offset)
+- [quickFilter](PageRequest.md#quickfilter)
+
+## Properties
+
+### limit
+
+• **limit**: `number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:621
+
+___
+
+### offset
+
+• **offset**: `number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:622
+
+___
+
+### quickFilter
+
+• `Optional` **quickFilter**: [`QuickFilter`](QuickFilter.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:623

package/interfaces/PaginationInfo.md

@@ -0,0 +1,63 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PaginationInfo
+
+# Interface: PaginationInfo
+
+## Table of contents
+
+### Properties
+
+- [currentPage](PaginationInfo.md#currentpage)
+- [firstRecord](PaginationInfo.md#firstrecord)
+- [hasMore](PaginationInfo.md#hasmore)
+- [lastRecord](PaginationInfo.md#lastrecord)
+- [total](PaginationInfo.md#total)
+
+## Properties
+
+### currentPage
+
+• **currentPage**: `number`
+
+#### Defined in
+
+src/dataunit/loading/PaginationInfo.ts:3
+
+___
+
+### firstRecord
+
+• **firstRecord**: `number`
+
+#### Defined in
+
+src/dataunit/loading/PaginationInfo.ts:4
+
+___
+
+### hasMore
+
+• **hasMore**: `boolean`
+
+#### Defined in
+
+src/dataunit/loading/PaginationInfo.ts:7
+
+___
+
+### lastRecord
+
+• **lastRecord**: `number`
+
+#### Defined in
+
+src/dataunit/loading/PaginationInfo.ts:5
+
+___
+
+### total
+
+• **total**: `number`
+
+#### Defined in
+
+src/dataunit/loading/PaginationInfo.ts:6

package/interfaces/QuickFilter.md

@@ -0,0 +1,30 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / QuickFilter
+
+# Interface: QuickFilter
+
+## Table of contents
+
+### Properties
+
+- [fields](QuickFilter.md#fields)
+- [term](QuickFilter.md#term)
+
+## Properties
+
+### fields
+
+• `Optional` **fields**: `string`[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:628
+
+___
+
+### term
+
+• **term**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:627

package/interfaces/Record.md

@@ -0,0 +1,40 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Record
+
+# Interface: Record
+
+## Hierarchy
+
+- **`Record`**
+
+  ↳ [`SavedRecord`](SavedRecord.md)
+
+## Indexable
+
+▪ [key: `string`]: `any`
+
+## Table of contents
+
+### Properties
+
+- [\_\_parent\_\_record\_\_id\_\_](Record.md#__parent__record__id__)
+- [\_\_record\_\_id\_\_](Record.md#__record__id__)
+
+## Properties
+
+### \_\_parent\_\_record\_\_id\_\_
+
+• `Optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:560
+
+___
+
+### \_\_record\_\_id\_\_
+
+• **\_\_record\_\_id\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:559

package/interfaces/SavedRecord.md

@@ -0,0 +1,55 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SavedRecord
+
+# Interface: SavedRecord
+
+## Hierarchy
+
+- [`Record`](Record.md)
+
+  ↳ **`SavedRecord`**
+
+## Table of contents
+
+### Properties
+
+- [\_\_old\_\_id\_\_](SavedRecord.md#__old__id__)
+- [\_\_parent\_\_record\_\_id\_\_](SavedRecord.md#__parent__record__id__)
+- [\_\_record\_\_id\_\_](SavedRecord.md#__record__id__)
+
+## Properties
+
+### \_\_old\_\_id\_\_
+
+• `Optional` **\_\_old\_\_id\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:565
+
+___
+
+### \_\_parent\_\_record\_\_id\_\_
+
+• `Optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
+
+#### Inherited from
+
+[Record](Record.md).[__parent__record__id__](Record.md#__parent__record__id__)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:560
+
+___
+
+### \_\_record\_\_id\_\_
+
+• **\_\_record\_\_id\_\_**: `string`
+
+#### Inherited from
+
+[Record](Record.md).[__record__id__](Record.md#__record__id__)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:559

package/interfaces/Sort.md

@@ -0,0 +1,41 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Sort
+
+# Interface: Sort
+
+## Table of contents
+
+### Properties
+
+- [dataType](Sort.md#datatype)
+- [field](Sort.md#field)
+- [mode](Sort.md#mode)
+
+## Properties
+
+### dataType
+
+• **dataType**: [`DataType`](../enums/DataType.md)
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:44
+
+___
+
+### field
+
+• **field**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:42
+
+___
+
+### mode
+
+• **mode**: [`SortMode`](../enums/SortMode.md)
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:43

package/interfaces/SortingProvider.md

@@ -0,0 +1,29 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SortingProvider
+
+# Interface: SortingProvider
+
+## Table of contents
+
+### Methods
+
+- [getSort](SortingProvider.md#getsort)
+
+## Methods
+
+### getSort
+
+▸ **getSort**(`dataUnit`): `undefined` \| [`Sort`](Sort.md)[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | `string` |
+
+#### Returns
+
+`undefined` \| [`Sort`](Sort.md)[]
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:53

package/interfaces/UnitMetadata.md

@@ -0,0 +1,41 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / UnitMetadata
+
+# Interface: UnitMetadata
+
+## Table of contents
+
+### Properties
+
+- [fields](UnitMetadata.md#fields)
+- [label](UnitMetadata.md#label)
+- [name](UnitMetadata.md#name)
+
+## Properties
+
+### fields
+
+• **fields**: [`FieldDescriptor`](FieldDescriptor.md)[]
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:6
+
+___
+
+### label
+
+• **label**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:5
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:4

package/interfaces/WaitingChange.md

@@ -0,0 +1,41 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / WaitingChange
+
+# Interface: WaitingChange
+
+## Table of contents
+
+### Properties
+
+- [blocking](WaitingChange.md#blocking)
+- [promise](WaitingChange.md#promise)
+- [waitmessage](WaitingChange.md#waitmessage)
+
+## Properties
+
+### blocking
+
+• **blocking**: `boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:616
+
+___
+
+### promise
+
+• `Optional` **promise**: `Promise`<`any`\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:617
+
+___
+
+### waitmessage
+
+• **waitmessage**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:615

package/modules/MaskFormatter.md

@@ -0,0 +1,37 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / MaskFormatter
+
+# Namespace: MaskFormatter
+
+## Table of contents
+
+### Type Aliases
+
+- [MaskCharacter](MaskFormatter.md#maskcharacter)
+
+### Variables
+
+- [MaskCharacter](MaskFormatter.md#maskcharacter-1)
+
+## Type Aliases
+
+### MaskCharacter
+
+Ƭ **MaskCharacter**: `InstanceType`<typeof [`MaskCharacter`](MaskFormatter.md#maskcharacter)\>
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:158
+
+src/utils/MaskFormatter.ts:322
+
+## Variables
+
+### MaskCharacter
+
+• **MaskCharacter**: typeof `__class`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:158
+
+src/utils/MaskFormatter.ts:322

package/modules.md

@@ -0,0 +1,63 @@
+[@sankhyalabs/core](README.md) / Exports
+
+# @sankhyalabs/core
+
+## Table of contents
+
+### Namespaces
+
+- [MaskFormatter](modules/MaskFormatter.md)
+
+### Enumerations
+
+- [Action](enums/Action.md)
+- [ChangeOperation](enums/ChangeOperation.md)
+- [DataType](enums/DataType.md)
+- [DependencyType](enums/DependencyType.md)
+- [SortMode](enums/SortMode.md)
+- [UserInterface](enums/UserInterface.md)
+
+### Classes
+
+- [ApplicationContext](classes/ApplicationContext.md)
+- [ArrayUtils](classes/ArrayUtils.md)
+- [AuthorizedServiceCaller](classes/AuthorizedServiceCaller.md)
+- [Change](classes/Change.md)
+- [DataUnit](classes/DataUnit.md)
+- [DataUnitAction](classes/DataUnitAction.md)
+- [DateUtils](classes/DateUtils.md)
+- [ElementIDUtils](classes/ElementIDUtils.md)
+- [ErrorException](classes/ErrorException.md)
+- [ErrorTracking](classes/ErrorTracking.md)
+- [FloatingManager](classes/FloatingManager.md)
+- [HttpProvider](classes/HttpProvider.md)
+- [MaskFormatter](classes/MaskFormatter-1.md)
+- [NumberUtils](classes/NumberUtils.md)
+- [ObjectUtils](classes/ObjectUtils.md)
+- [ReadyUtil](classes/ReadyUtil.md)
+- [RequestMetadata](classes/RequestMetadata.md)
+- [SkwHttpProvider](classes/SkwHttpProvider.md)
+- [StringUtils](classes/StringUtils.md)
+- [TimeFormatter](classes/TimeFormatter.md)
+- [UserAgentUtils](classes/UserAgentUtils.md)
+- [WaitingChangeException](classes/WaitingChangeException.md)
+- [WarningException](classes/WarningException.md)
+
+### Interfaces
+
+- [DUActionInterceptor](interfaces/DUActionInterceptor.md)
+- [ExecutionContext](interfaces/ExecutionContext.md)
+- [FieldDescriptor](interfaces/FieldDescriptor.md)
+- [Filter](interfaces/Filter.md)
+- [IElementIDInfo](interfaces/IElementIDInfo.md)
+- [LoadDataRequest](interfaces/LoadDataRequest.md)
+- [LoadDataResponse](interfaces/LoadDataResponse.md)
+- [PageRequest](interfaces/PageRequest.md)
+- [PaginationInfo](interfaces/PaginationInfo.md)
+- [QuickFilter](interfaces/QuickFilter.md)
+- [Record](interfaces/Record.md)
+- [SavedRecord](interfaces/SavedRecord.md)
+- [Sort](interfaces/Sort.md)
+- [SortingProvider](interfaces/SortingProvider.md)
+- [UnitMetadata](interfaces/UnitMetadata.md)
+- [WaitingChange](interfaces/WaitingChange.md)

package/package.json

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