@sankhyalabs/core-docs 2.3.0 → 2.3.1-SKA-61927.3

package/enums/DataType.md

@@ -1,63 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DataType
-
-# Enumeration: DataType
-
-## Table of contents
-
-### Enumeration Members
-
-- [BOOLEAN](DataType.md#boolean)
-- [DATE](DataType.md#date)
-- [NUMBER](DataType.md#number)
-- [OBJECT](DataType.md#object)
-- [TEXT](DataType.md#text)
-
-## Enumeration Members
-
-### BOOLEAN
-
-• **BOOLEAN** = ``"BOOLEAN"``
-
-#### Defined in
-
-src/dataunit/metadata/DataType.ts:7
-
-___
-
-### DATE
-
-• **DATE** = ``"DATE"``
-
-#### Defined in
-
-src/dataunit/metadata/DataType.ts:5
-
-___
-
-### NUMBER
-
-• **NUMBER** = ``"NUMBER"``
-
-#### Defined in
-
-src/dataunit/metadata/DataType.ts:4
-
-___
-
-### OBJECT
-
-• **OBJECT** = ``"OBJECT"``
-
-#### Defined in
-
-src/dataunit/metadata/DataType.ts:8
-
-___
-
-### TEXT
-
-• **TEXT** = ``"TEXT"``
-
-#### Defined in
-
-src/dataunit/metadata/DataType.ts:6

package/enums/DependencyType.md

@@ -1,41 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DependencyType
-
-# Enumeration: DependencyType
-
-## Table of contents
-
-### Enumeration Members
-
-- [REQUIREMENT](DependencyType.md#requirement)
-- [SEARCHING](DependencyType.md#searching)
-- [VISIBILITY](DependencyType.md#visibility)
-
-## Enumeration Members
-
-### REQUIREMENT
-
-• **REQUIREMENT** = ``"REQUIREMENT"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:63
-
-___
-
-### SEARCHING
-
-• **SEARCHING** = ``"SEARCHING"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:62
-
-___
-
-### VISIBILITY
-
-• **VISIBILITY** = ``"REQUIREMENT"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:64

package/enums/SortMode.md

@@ -1,30 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SortMode
-
-# Enumeration: SortMode
-
-## Table of contents
-
-### Enumeration Members
-
-- [ASC](SortMode.md#asc)
-- [DESC](SortMode.md#desc)
-
-## Enumeration Members
-
-### ASC
-
-• **ASC** = ``"ASC"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:57
-
-___
-
-### DESC
-
-• **DESC** = ``"DESC"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:58

package/enums/UserInterface.md

@@ -1,195 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / UserInterface
-
-# Enumeration: UserInterface
-
-## Table of contents
-
-### Enumeration Members
-
-- [CHECKBOX](UserInterface.md#checkbox)
-- [DATE](UserInterface.md#date)
-- [DATETIME](UserInterface.md#datetime)
-- [DECIMALNUMBER](UserInterface.md#decimalnumber)
-- [ELAPSEDTIME](UserInterface.md#elapsedtime)
-- [FILE](UserInterface.md#file)
-- [HTML](UserInterface.md#html)
-- [IMAGE](UserInterface.md#image)
-- [INTEGERNUMBER](UserInterface.md#integernumber)
-- [LONGTEXT](UserInterface.md#longtext)
-- [MASKEDTEXT](UserInterface.md#maskedtext)
-- [OPTIONSELECTOR](UserInterface.md#optionselector)
-- [PASSWORD](UserInterface.md#password)
-- [SEARCH](UserInterface.md#search)
-- [SHORTTEXT](UserInterface.md#shorttext)
-- [SWITCH](UserInterface.md#switch)
-- [TIME](UserInterface.md#time)
-
-## Enumeration Members
-
-### CHECKBOX
-
-• **CHECKBOX** = ``"CHECKBOX"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:74
-
-___
-
-### DATE
-
-• **DATE** = ``"DATE"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:70
-
-___
-
-### DATETIME
-
-• **DATETIME** = ``"DATETIME"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:71
-
-___
-
-### DECIMALNUMBER
-
-• **DECIMALNUMBER** = ``"DECIMALNUMBER"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:77
-
-___
-
-### ELAPSEDTIME
-
-• **ELAPSEDTIME** = ``"ELAPSEDTIME"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:73
-
-___
-
-### FILE
-
-• **FILE** = ``"FILE"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:68
-
-___
-
-### HTML
-
-• **HTML** = ``"HTML"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:84
-
-___
-
-### IMAGE
-
-• **IMAGE** = ``"IMAGE"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:69
-
-___
-
-### INTEGERNUMBER
-
-• **INTEGERNUMBER** = ``"INTEGERNUMBER"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:78
-
-___
-
-### LONGTEXT
-
-• **LONGTEXT** = ``"LONGTEXT"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:83
-
-___
-
-### MASKEDTEXT
-
-• **MASKEDTEXT** = ``"MASKEDTEXT"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:82
-
-___
-
-### OPTIONSELECTOR
-
-• **OPTIONSELECTOR** = ``"OPTIONSELECTOR"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:76
-
-___
-
-### PASSWORD
-
-• **PASSWORD** = ``"PASSWORD"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:81
-
-___
-
-### SEARCH
-
-• **SEARCH** = ``"SEARCH"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:79
-
-___
-
-### SHORTTEXT
-
-• **SHORTTEXT** = ``"SHORTTEXT"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:80
-
-___
-
-### SWITCH
-
-• **SWITCH** = ``"SWITCH"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:75
-
-___
-
-### TIME
-
-• **TIME** = ``"TIME"``
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:72

package/interfaces/DUActionInterceptor.md

@@ -1,29 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DUActionInterceptor
-
-# Interface: DUActionInterceptor
-
-## Table of contents
-
-### Methods
-
-- [interceptAction](DUActionInterceptor.md#interceptaction)
-
-## Methods
-
-### interceptAction
-
-▸ **interceptAction**(`action`): [`DataUnitAction`](../classes/DataUnitAction.md) \| `Promise`<[`DataUnitAction`](../classes/DataUnitAction.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
-
-#### Returns
-
-[`DataUnitAction`](../classes/DataUnitAction.md) \| `Promise`<[`DataUnitAction`](../classes/DataUnitAction.md)\>
-
-#### Defined in
-
-src/dataunit/DataUnit.ts:555

package/interfaces/ExecutionContext.md

@@ -1,58 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ExecutionContext
-
-# Interface: ExecutionContext
-
-## Table of contents
-
-### Properties
-
-- [after](ExecutionContext.md#after)
-- [before](ExecutionContext.md#before)
-
-## Properties
-
-### after
-
-• `Optional` **after**: (`action`: [`DataUnitAction`](../classes/DataUnitAction.md)) => `void`
-
-#### Type declaration
-
-▸ (`action`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-src/dataunit/state/action/DataUnitAction.ts:24
-
-___
-
-### before
-
-• `Optional` **before**: (`action`: [`DataUnitAction`](../classes/DataUnitAction.md)) => [`DataUnitAction`](../classes/DataUnitAction.md)
-
-#### Type declaration
-
-▸ (`action`): [`DataUnitAction`](../classes/DataUnitAction.md)
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
-
-##### Returns
-
-[`DataUnitAction`](../classes/DataUnitAction.md)
-
-#### Defined in
-
-src/dataunit/state/action/DataUnitAction.ts:23

package/interfaces/FieldDescriptor.md

@@ -1,129 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / FieldDescriptor
-
-# Interface: FieldDescriptor
-
-## Table of contents
-
-### Properties
-
-- [dataType](FieldDescriptor.md#datatype)
-- [defaultValue](FieldDescriptor.md#defaultvalue)
-- [dependencies](FieldDescriptor.md#dependencies)
-- [group](FieldDescriptor.md#group)
-- [label](FieldDescriptor.md#label)
-- [name](FieldDescriptor.md#name)
-- [properties](FieldDescriptor.md#properties)
-- [readOnly](FieldDescriptor.md#readonly)
-- [required](FieldDescriptor.md#required)
-- [userInterface](FieldDescriptor.md#userinterface)
-- [visible](FieldDescriptor.md#visible)
-
-## Properties
-
-### dataType
-
-• **dataType**: [`DataType`](../enums/DataType.md)
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:12
-
-___
-
-### defaultValue
-
-• `Optional` **defaultValue**: `any`
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:14
-
-___
-
-### dependencies
-
-• `Optional` **dependencies**: `FieldDependency`[]
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:19
-
-___
-
-### group
-
-• `Optional` **group**: `string`
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:20
-
-___
-
-### label
-
-• **label**: `string`
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:11
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:10
-
-___
-
-### properties
-
-• `Optional` **properties**: `any`
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:18
-
-___
-
-### readOnly
-
-• `Optional` **readOnly**: `boolean`
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:16
-
-___
-
-### required
-
-• `Optional` **required**: `boolean`
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:17
-
-___
-
-### userInterface
-
-• `Optional` **userInterface**: [`UserInterface`](../enums/UserInterface.md)
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:13
-
-___
-
-### visible
-
-• `Optional` **visible**: `boolean`
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:15

package/interfaces/Filter.md

@@ -1,41 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Filter
-
-# Interface: Filter
-
-## Table of contents
-
-### Properties
-
-- [expression](Filter.md#expression)
-- [name](Filter.md#name)
-- [params](Filter.md#params)
-
-## Properties
-
-### expression
-
-• **expression**: `string`
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:31
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:30
-
-___
-
-### params
-
-• `Optional` **params**: `FilterParam`[]
-
-#### Defined in
-
-src/dataunit/metadata/UnitMetadata.ts:32

package/interfaces/IElementIDInfo.md

@@ -1,30 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IElementIDInfo
-
-# Interface: IElementIDInfo
-
-## Table of contents
-
-### Properties
-
-- [dataUnit](IElementIDInfo.md#dataunit)
-- [id](IElementIDInfo.md#id)
-
-## Properties
-
-### dataUnit
-
-• `Optional` **dataUnit**: [`DataUnit`](../classes/DataUnit.md)
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:7
-
-___
-
-### id
-
-• `Optional` **id**: `string`
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:6

package/interfaces/LoadDataRequest.md

@@ -1,63 +0,0 @@
-[@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

@@ -1,30 +0,0 @@
-[@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