@sankhyalabs/core-docs 0.0.0-bugfix-dev-KB-6165.0

package/interfaces/Record.md

@@ -0,0 +1,62 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Record
+
+# Interface: Record
+
+## Hierarchy
+
+- **`Record`**
+
+  ↳ [`SavedRecord`](SavedRecord.md)
+
+## Indexable
+
+▪ [key: `string`]: `any`
+
+## Table of contents
+
+### Properties
+
+- [\_\_owner\_\_dataunit\_\_name\_\_](Record.md#__owner__dataunit__name__)
+- [\_\_parent\_\_record\_\_id\_\_](Record.md#__parent__record__id__)
+- [\_\_record\_\_id\_\_](Record.md#__record__id__)
+- [\_\_record\_\_label\_\_](Record.md#__record__label__)
+
+## Properties
+
+### \_\_owner\_\_dataunit\_\_name\_\_
+
+• `Optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1664
+
+___
+
+### \_\_parent\_\_record\_\_id\_\_
+
+• `Optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1663
+
+___
+
+### \_\_record\_\_id\_\_
+
+• **\_\_record\_\_id\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1661
+
+___
+
+### \_\_record\_\_label\_\_
+
+• `Optional` **\_\_record\_\_label\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1662

package/interfaces/SavedRecord.md

@@ -0,0 +1,85 @@
+[@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__)
+- [\_\_owner\_\_dataunit\_\_name\_\_](SavedRecord.md#__owner__dataunit__name__)
+- [\_\_parent\_\_record\_\_id\_\_](SavedRecord.md#__parent__record__id__)
+- [\_\_record\_\_id\_\_](SavedRecord.md#__record__id__)
+- [\_\_record\_\_label\_\_](SavedRecord.md#__record__label__)
+
+## Properties
+
+### \_\_old\_\_id\_\_
+
+• `Optional` **\_\_old\_\_id\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1669
+
+___
+
+### \_\_owner\_\_dataunit\_\_name\_\_
+
+• `Optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
+
+#### Inherited from
+
+[Record](Record.md).[__owner__dataunit__name__](Record.md#__owner__dataunit__name__)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1664
+
+___
+
+### \_\_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:1663
+
+___
+
+### \_\_record\_\_id\_\_
+
+• **\_\_record\_\_id\_\_**: `string`
+
+#### Inherited from
+
+[Record](Record.md).[__record__id__](Record.md#__record__id__)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1661
+
+___
+
+### \_\_record\_\_label\_\_
+
+• `Optional` **\_\_record\_\_label\_\_**: `string`
+
+#### Inherited from
+
+[Record](Record.md).[__record__label__](Record.md#__record__label__)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1662

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:57
+
+___
+
+### field
+
+• **field**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:55
+
+___
+
+### mode
+
+• **mode**: [`SortMode`](../enums/SortMode.md)
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:56

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:66

package/interfaces/UnitMetadata.md

@@ -0,0 +1,52 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / UnitMetadata
+
+# Interface: UnitMetadata
+
+## Table of contents
+
+### Properties
+
+- [children](UnitMetadata.md#children)
+- [fields](UnitMetadata.md#fields)
+- [label](UnitMetadata.md#label)
+- [name](UnitMetadata.md#name)
+
+## Properties
+
+### children
+
+• `Optional` **children**: [`ChildDescriptor`](ChildDescriptor.md)[]
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:7
+
+___
+
+### 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:1759
+
+___
+
+### promise
+
+• `Optional` **promise**: `Promise`<`any`\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1760
+
+___
+
+### waitmessage
+
+• **waitmessage**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1758

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:166
+
+src/utils/MaskFormatter.ts:406
+
+## Variables
+
+### MaskCharacter
+
+• **MaskCharacter**: typeof `__class`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:166
+
+src/utils/MaskFormatter.ts:406

package/modules.md

@@ -0,0 +1,74 @@
+[@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)
+- [SelectionMode](enums/SelectionMode.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)
+- [DataUnitStorage](classes/DataUnitStorage.md)
+- [DateUtils](classes/DateUtils.md)
+- [ElementIDUtils](classes/ElementIDUtils.md)
+- [ErrorException](classes/ErrorException.md)
+- [ErrorTracking](classes/ErrorTracking.md)
+- [FloatingManager](classes/FloatingManager.md)
+- [HTMLBuilder](classes/HTMLBuilder.md)
+- [HttpProvider](classes/HttpProvider.md)
+- [JSUtils](classes/JSUtils.md)
+- [MaskFormatter](classes/MaskFormatter-1.md)
+- [NumberUtils](classes/NumberUtils.md)
+- [ObjectUtils](classes/ObjectUtils.md)
+- [OnboardingUtils](classes/OnboardingUtils.md)
+- [PromiseSync](classes/PromiseSync.md)
+- [ReadyUtil](classes/ReadyUtil.md)
+- [RequestMetadata](classes/RequestMetadata.md)
+- [SelectionInfo](classes/SelectionInfo.md)
+- [SkwHttpProvider](classes/SkwHttpProvider.md)
+- [StringUtils](classes/StringUtils.md)
+- [TimeFormatter](classes/TimeFormatter.md)
+- [UserAgentUtils](classes/UserAgentUtils.md)
+- [VersionUtils](classes/VersionUtils.md)
+- [WaitingChangeException](classes/WaitingChangeException.md)
+- [WarningException](classes/WarningException.md)
+
+### Interfaces
+
+- [ChildDescriptor](interfaces/ChildDescriptor.md)
+- [ChildLink](interfaces/ChildLink.md)
+- [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)
+- [PromiseSyncCallback](interfaces/PromiseSyncCallback.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

@@ -0,0 +1,14 @@
+{
+    "name": "@sankhyalabs/core-docs",
+    "version": "0.0.0-bugfix-dev-KB-6165.0",
+    "description": "Documentação da biblioteca de componentes Sankhya.",
+    "main": "",
+    "files": [
+        "/**/*.md"
+    ],
+    "scripts": {},
+    "publishConfig": {
+        "access": "public"
+    },
+    "devDependencies": {}
+}