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

package/classes/DataUnitAction.md

@@ -1,96 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DataUnitAction
-
-# Class: DataUnitAction
-
-## Implements
-
-- `StateAction`
-
-## Table of contents
-
-### Constructors
-
-- [constructor](DataUnitAction.md#constructor)
-
-### Properties
-
-- [\_payload](DataUnitAction.md#_payload)
-- [\_type](DataUnitAction.md#_type)
-
-### Accessors
-
-- [payload](DataUnitAction.md#payload)
-- [type](DataUnitAction.md#type)
-
-## Constructors
-
-### constructor
-
-• **new DataUnitAction**(`type`, `payload?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `type` | [`Action`](../enums/Action.md) |
-| `payload?` | `any` |
-
-#### Defined in
-
-src/dataunit/state/action/DataUnitAction.ts:9
-
-## Properties
-
-### \_payload
-
-• `Private` **\_payload**: `any`
-
-#### Defined in
-
-src/dataunit/state/action/DataUnitAction.ts:7
-
-___
-
-### \_type
-
-• `Private` **\_type**: [`Action`](../enums/Action.md)
-
-#### Defined in
-
-src/dataunit/state/action/DataUnitAction.ts:6
-
-## Accessors
-
-### payload
-
-• `get` **payload**(): `any`
-
-#### Returns
-
-`any`
-
-#### Implementation of
-
-StateAction.payload
-
-#### Defined in
-
-src/dataunit/state/action/DataUnitAction.ts:18
-
-___
-
-### type
-
-• `get` **type**(): [`Action`](../enums/Action.md)
-
-#### Returns
-
-[`Action`](../enums/Action.md)
-
-#### Implementation of
-
-StateAction.type
-
-#### Defined in
-
-src/dataunit/state/action/DataUnitAction.ts:14

package/classes/DateUtils.md

@@ -1,190 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DateUtils
-
-# Class: DateUtils
-
-## Table of contents
-
-### Constructors
-
-- [constructor](DateUtils.md#constructor)
-
-### Methods
-
-- [adjustDLST](DateUtils.md#adjustdlst)
-- [clearTime](DateUtils.md#cleartime)
-- [formatRfc3339](DateUtils.md#formatrfc3339)
-- [getToday](DateUtils.md#gettoday)
-- [pad](DateUtils.md#pad)
-- [strToDate](DateUtils.md#strtodate)
-- [timezoneOffset](DateUtils.md#timezoneoffset)
-- [validateDate](DateUtils.md#validatedate)
-
-## Constructors
-
-### constructor
-
-• **new DateUtils**()
-
-## Methods
-
-### adjustDLST
-
-▸ `Static` `Private` **adjustDLST**(`date`): `Date`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `date` | `Date` |
-
-#### Returns
-
-`Date`
-
-#### Defined in
-
-src/utils/DateUtils.ts:60
-
-___
-
-### clearTime
-
-▸ `Static` **clearTime**(`date`, `adjustDayLightSavingTime?`): `Date`
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `date` | `Date` | `undefined` |
-| `adjustDayLightSavingTime` | `boolean` | `true` |
-
-#### Returns
-
-`Date`
-
-#### Defined in
-
-src/utils/DateUtils.ts:3
-
-___
-
-### formatRfc3339
-
-▸ `Static` **formatRfc3339**(`date`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `date` | `Date` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/DateUtils.ts:87
-
-___
-
-### getToday
-
-▸ `Static` **getToday**(`withTime?`): `Date`
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `withTime` | `boolean` | `false` |
-
-#### Returns
-
-`Date`
-
-#### Defined in
-
-src/utils/DateUtils.ts:44
-
-___
-
-### pad
-
-▸ `Static` `Private` **pad**(`n`): `string` \| `Number`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `n` | `Number` |
-
-#### Returns
-
-`string` \| `Number`
-
-#### Defined in
-
-src/utils/DateUtils.ts:70
-
-___
-
-### strToDate
-
-▸ `Static` **strToDate**(`strValue`, `adjustDayLightSavingTime?`, `monthYearMode?`): `undefined` \| `Date`
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `strValue` | `string` | `undefined` |
-| `adjustDayLightSavingTime` | `boolean` | `true` |
-| `monthYearMode` | `boolean` | `false` |
-
-#### Returns
-
-`undefined` \| `Date`
-
-#### Defined in
-
-src/utils/DateUtils.ts:8
-
-___
-
-### timezoneOffset
-
-▸ `Static` `Private` **timezoneOffset**(`offset`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `offset` | `number` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/DateUtils.ts:74
-
-___
-
-### validateDate
-
-▸ `Static` **validateDate**(`value`, `hasTime?`): `undefined` \| `Date`
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `value` | `Date` | `undefined` |
-| `hasTime` | `boolean` | `false` |
-
-#### Returns
-
-`undefined` \| `Date`
-
-#### Defined in
-
-src/utils/DateUtils.ts:54

package/classes/ElementIDUtils.md

@@ -1,222 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ElementIDUtils
-
-# Class: ElementIDUtils
-
-## Table of contents
-
-### Constructors
-
-- [constructor](ElementIDUtils.md#constructor)
-
-### Properties
-
-- [DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME](ElementIDUtils.md#data_element_id_attribute_name)
-- [INTERNAL\_INPUT\_NAME](ElementIDUtils.md#internal_input_name)
-
-### Methods
-
-- [addIDInfo](ElementIDUtils.md#addidinfo)
-- [addIDInfoIfNotExists](ElementIDUtils.md#addidinfoifnotexists)
-- [addPrefix](ElementIDUtils.md#addprefix)
-- [addSuffix](ElementIDUtils.md#addsuffix)
-- [formatDescription](ElementIDUtils.md#formatdescription)
-- [getAttributeValid](ElementIDUtils.md#getattributevalid)
-- [getDataElementID](ElementIDUtils.md#getdataelementid)
-- [getInternalIDInfo](ElementIDUtils.md#getinternalidinfo)
-
-## Constructors
-
-### constructor
-
-• **new ElementIDUtils**()
-
-## Properties
-
-### DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME
-
-▪ `Static` **DATA\_ELEMENT\_ID\_ATTRIBUTE\_NAME**: `string` = `"data-element-id"`
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:12
-
-___
-
-### INTERNAL\_INPUT\_NAME
-
-▪ `Static` **INTERNAL\_INPUT\_NAME**: `string` = `"internal"`
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:13
-
-## Methods
-
-### addIDInfo
-
-▸ `Static` **addIDInfo**(`element`, `suffix?`, `iDInfo?`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
-| `suffix?` | `string` |
-| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:15
-
-___
-
-### addIDInfoIfNotExists
-
-▸ `Static` **addIDInfoIfNotExists**(`element`, `suffix?`, `iDInfo?`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
-| `suffix?` | `string` |
-| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:24
-
-___
-
-### addPrefix
-
-▸ `Static` `Private` **addPrefix**(`iDInfo`, `dataElementID`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `iDInfo` | `undefined` \| [`IElementIDInfo`](../interfaces/IElementIDInfo.md) |
-| `dataElementID` | `string` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:88
-
-___
-
-### addSuffix
-
-▸ `Static` `Private` **addSuffix**(`dataElementID`, `suffix`, `element`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `dataElementID` | ``null`` \| `string` |
-| `suffix` | `undefined` \| `string` |
-| `element` | `HTMLElement` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:78
-
-___
-
-### formatDescription
-
-▸ `Static` `Private` **formatDescription**(`value`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `value` | ``null`` \| `string` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:98
-
-___
-
-### getAttributeValid
-
-▸ `Static` `Private` **getAttributeValid**(`element`, `iDInfo?`): ``null`` \| `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
-| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) |
-
-#### Returns
-
-``null`` \| `string`
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:55
-
-___
-
-### getDataElementID
-
-▸ `Static` `Private` **getDataElementID**(`element`, `suffix?`, `iDInfo?`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
-| `suffix?` | `string` |
-| `iDInfo?` | [`IElementIDInfo`](../interfaces/IElementIDInfo.md) |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:39
-
-___
-
-### getInternalIDInfo
-
-▸ `Static` **getInternalIDInfo**(`originalID`, `sufix`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `originalID` | `string` |
-| `sufix` | `string` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-src/utils/ElementIDUtils.ts:35

package/classes/ErrorException.md

@@ -1,204 +0,0 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ErrorException
-
-# Class: ErrorException
-
-## Hierarchy
-
-- `Error`
-
-  ↳ **`ErrorException`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](ErrorException.md#constructor)
-
-### Properties
-
-- [cause](ErrorException.md#cause)
-- [errorCode](ErrorException.md#errorcode)
-- [message](ErrorException.md#message)
-- [name](ErrorException.md#name)
-- [stack](ErrorException.md#stack)
-- [title](ErrorException.md#title)
-- [prepareStackTrace](ErrorException.md#preparestacktrace)
-- [stackTraceLimit](ErrorException.md#stacktracelimit)
-
-### Methods
-
-- [captureStackTrace](ErrorException.md#capturestacktrace)
-
-## Constructors
-
-### constructor
-
-• **new ErrorException**(`title`, `message`, `errorCode?`)
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `title` | `string` | `undefined` |
-| `message` | `string` | `undefined` |
-| `errorCode` | `string` | `""` |
-
-#### Overrides
-
-Error.constructor
-
-#### Defined in
-
-src/exceptions/ErrorException.ts:7
-
-## Properties
-
-### cause
-
-• `Optional` **cause**: `unknown`
-
-#### Inherited from
-
-Error.cause
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es2022.error.d.ts:26
-
-___
-
-### errorCode
-
-• **errorCode**: `string`
-
-#### Defined in
-
-src/exceptions/ErrorException.ts:5
-
-___
-
-### message
-
-• **message**: `string`
-
-#### Overrides
-
-Error.message
-
-#### Defined in
-
-src/exceptions/ErrorException.ts:4
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-Error.name
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1053
-
-___
-
-### stack
-
-• `Optional` **stack**: `string`
-
-#### Inherited from
-
-Error.stack
-
-#### Defined in
-
-node_modules/typescript/lib/lib.es5.d.ts:1055
-
-___
-
-### title
-
-• **title**: `string`
-
-#### Defined in
-
-src/exceptions/ErrorException.ts:3
-
-___
-
-### prepareStackTrace
-
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
-
-#### Type declaration
-
-▸ (`err`, `stackTraces`): `any`
-
-Optional override for formatting stack traces
-
-**`See`**
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
-
-##### Returns
-
-`any`
-
-#### Inherited from
-
-Error.prepareStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:11
-
-___
-
-### stackTraceLimit
-
-▪ `Static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-Error.stackTraceLimit
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:13
-
-## Methods
-
-### captureStackTrace
-
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-Error.captureStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:4