@sankhyalabs/core-docs 5.20.0-rc.9 → 6.0.0

package/classes/SelectionInfo.md

@@ -30,7 +30,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1925
+src/dataunit/DataUnit.ts:2088
 
 ## Properties
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1925
 
 #### Source
 
-src/dataunit/DataUnit.ts:1919
+src/dataunit/DataUnit.ts:2085
 
 ***
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1919
 
 #### Source
 
-src/dataunit/DataUnit.ts:1921
+src/dataunit/DataUnit.ts:2086
 
 ***
 
@@ -60,7 +60,21 @@ src/dataunit/DataUnit.ts:1921
 
 #### Source
 
-src/dataunit/DataUnit.ts:1922
+src/dataunit/DataUnit.ts:2082
+
+***
+
+### getAllRecords()?
+
+> `optional` **getAllRecords**: () => `undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+`undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/DataUnit.ts:2084
 
 ***
 
@@ -70,7 +84,7 @@ src/dataunit/DataUnit.ts:1922
 
 #### Source
 
-src/dataunit/DataUnit.ts:1920
+src/dataunit/DataUnit.ts:2081
 
 ***
 
@@ -80,7 +94,7 @@ src/dataunit/DataUnit.ts:1920
 
 #### Source
 
-src/dataunit/DataUnit.ts:1923
+src/dataunit/DataUnit.ts:2083
 
 ## Accessors
 
@@ -94,7 +108,7 @@ src/dataunit/DataUnit.ts:1923
 
 #### Source
 
-src/dataunit/DataUnit.ts:1950
+src/dataunit/DataUnit.ts:2116
 
 ***
 
@@ -108,7 +122,7 @@ src/dataunit/DataUnit.ts:1950
 
 #### Source
 
-src/dataunit/DataUnit.ts:1940
+src/dataunit/DataUnit.ts:2106
 
 ***
 
@@ -122,7 +136,7 @@ src/dataunit/DataUnit.ts:1940
 
 #### Source
 
-src/dataunit/DataUnit.ts:1933
+src/dataunit/DataUnit.ts:2096
 
 ## Methods
 
@@ -136,7 +150,7 @@ src/dataunit/DataUnit.ts:1933
 
 #### Source
 
-src/dataunit/DataUnit.ts:1957
+src/dataunit/DataUnit.ts:2123
 
 ***
 
@@ -150,4 +164,4 @@ src/dataunit/DataUnit.ts:1957
 
 #### Source
 
-src/dataunit/DataUnit.ts:1961
+src/dataunit/DataUnit.ts:2127

package/classes/ServiceCanceledException.md

@@ -0,0 +1,193 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / ServiceCanceledException
+
+# Class: ServiceCanceledException
+
+`ServiceCanceledException`: Exceção lançada quando ocorre o cancelamento de um serviço.
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### new ServiceCanceledException()
+
+> **new ServiceCanceledException**(`title`, `message`, `errorCode`): [`ServiceCanceledException`](ServiceCanceledException.md)
+
+#### Parameters
+
+• **title**: `string`
+
+• **message**: `string`
+
+• **errorCode**: `string`= `""`
+
+#### Returns
+
+[`ServiceCanceledException`](ServiceCanceledException.md)
+
+#### Overrides
+
+`Error.constructor`
+
+#### Source
+
+src/exceptions/ServiceCanceledException.ts:18
+
+## Properties
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+#### Inherited from
+
+`Error.cause`
+
+#### Source
+
+node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+***
+
+### errorCode
+
+> **errorCode**: `string`
+
+Código do erro, indica o erro disparado pelo backend.
+
+#### Source
+
+src/exceptions/ServiceCanceledException.ts:16
+
+***
+
+### message
+
+> **message**: `string`
+
+Descrição do erro.
+
+#### Overrides
+
+`Error.message`
+
+#### Source
+
+src/exceptions/ServiceCanceledException.ts:13
+
+***
+
+### name
+
+> **name**: `string`
+
+Nome da exceção.
+
+#### Overrides
+
+`Error.name`
+
+#### Source
+
+src/exceptions/ServiceCanceledException.ts:7
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+#### Inherited from
+
+`Error.stack`
+
+#### Source
+
+node\_modules/typescript/lib/lib.es5.d.ts:1055
+
+***
+
+### title
+
+> **title**: `string`
+
+Titulo do erro.
+
+#### Source
+
+src/exceptions/ServiceCanceledException.ts:10
+
+***
+
+### prepareStackTrace()?
+
+> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
+
+Optional override for formatting stack traces
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Parameters
+
+• **err**: `Error`
+
+• **stackTraces**: `CallSite`[]
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+`Error.prepareStackTrace`
+
+#### Source
+
+node\_modules/@types/node/globals.d.ts:27
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+`Error.stackTraceLimit`
+
+#### Source
+
+node\_modules/@types/node/globals.d.ts:29
+
+## Methods
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+• **targetObject**: `object`
+
+• **constructorOpt?**: `Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Error.captureStackTrace`
+
+#### Source
+
+node\_modules/@types/node/globals.d.ts:20

package/classes/ServiceUtils.md

@@ -0,0 +1,67 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / ServiceUtils
+
+# Class: ServiceUtils
+
+## Constructors
+
+### new ServiceUtils()
+
+> **new ServiceUtils**(): [`ServiceUtils`](ServiceUtils.md)
+
+#### Returns
+
+[`ServiceUtils`](ServiceUtils.md)
+
+## Methods
+
+### useCacheWithService()
+
+> `static` **useCacheWithService**\<`T`\>(`identifier`, `fetchFunction`, `storageType`): `Promise`\<`T`\>
+
+Auxilia no uso do CacheManager, gerando automaticamente uma chave de cache com base no identificador.
+
+#### Type parameters
+
+• **T**
+
+Tipo do dado a ser retornado.
+
+#### Parameters
+
+• **identifier**: `string`
+
+Identificadores únicos usados para compor a chave de cache.
+
+• **fetchFunction**
+
+Função que retorna uma `Promise` com o valor a ser armazenado no cache caso ele não exista ou tenha expirado.
+
+• **storageType**: [`StorageType`](../enumerations/StorageType.md)= `StorageType.IN_MEMORY_CACHE`
+
+Tipo de armazenamento: `'sessionStorage'` ou `'localStorage'`. O padrão é `'sessionStorage'`.
+
+#### Returns
+
+`Promise`\<`T`\>
+
+Uma `Promise` com o valor armazenado ou obtido via `fetchFunction`.
+
+#### Example
+
+```typescript
+const actions = await useCacheWithService(
+ `${this.entityName} - ${this.resourceID}`,
+  async () => {
+    return await fetchActionsFromAPI();
+  }
+);
+console.log(actions);
+```
+
+#### Source
+
+src/utils/ServiceUtils.ts:28

package/classes/SilentException.md

@@ -0,0 +1,193 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / SilentException
+
+# Class: SilentException
+
+`SilentException`: Exceção lançada quando uma exception silenciosa é.
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### new SilentException()
+
+> **new SilentException**(`title`, `message`, `errorCode`): [`SilentException`](SilentException.md)
+
+#### Parameters
+
+• **title**: `string`= `""`
+
+• **message**: `string`= `""`
+
+• **errorCode**: `string`= `""`
+
+#### Returns
+
+[`SilentException`](SilentException.md)
+
+#### Overrides
+
+`Error.constructor`
+
+#### Source
+
+src/exceptions/SilentException.ts:18
+
+## Properties
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+#### Inherited from
+
+`Error.cause`
+
+#### Source
+
+node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+***
+
+### errorCode
+
+> **errorCode**: `string`
+
+Código do erro, indica o erro disparado pelo backend.
+
+#### Source
+
+src/exceptions/SilentException.ts:16
+
+***
+
+### message
+
+> **message**: `string`
+
+Descrição do erro.
+
+#### Overrides
+
+`Error.message`
+
+#### Source
+
+src/exceptions/SilentException.ts:13
+
+***
+
+### name
+
+> **name**: `string`
+
+Nome da exceção.
+
+#### Overrides
+
+`Error.name`
+
+#### Source
+
+src/exceptions/SilentException.ts:7
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+#### Inherited from
+
+`Error.stack`
+
+#### Source
+
+node\_modules/typescript/lib/lib.es5.d.ts:1055
+
+***
+
+### title
+
+> **title**: `string`
+
+Titulo do erro.
+
+#### Source
+
+src/exceptions/SilentException.ts:10
+
+***
+
+### prepareStackTrace()?
+
+> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
+
+Optional override for formatting stack traces
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Parameters
+
+• **err**: `Error`
+
+• **stackTraces**: `CallSite`[]
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+`Error.prepareStackTrace`
+
+#### Source
+
+node\_modules/@types/node/globals.d.ts:27
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+`Error.stackTraceLimit`
+
+#### Source
+
+node\_modules/@types/node/globals.d.ts:29
+
+## Methods
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+• **targetObject**: `object`
+
+• **constructorOpt?**: `Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Error.captureStackTrace`
+
+#### Source
+
+node\_modules/@types/node/globals.d.ts:20

package/classes/StringUtils.md

@@ -76,6 +76,30 @@ src/utils/StringUtils.ts:71
 
 ***
 
+### escapeString()
+
+> `static` **escapeString**(`str`): `string`
+
+Escapa caracteres especiais em uma string, usando sequencias de escape Unicode.
+
+#### Parameters
+
+• **str**: `string`
+
+A string que deve sofrer alteração.
+
+#### Returns
+
+`string`
+
+String com valores alterados.
+
+#### Source
+
+src/utils/StringUtils.ts:548
+
+***
+
 ### formatBytes()
 
 > `static` **formatBytes**(`bytes`): `string`

package/classes/UserAgentUtils.md

@@ -34,7 +34,21 @@ Objeto com o nome e versão do navegador.
 
 #### Source
 
-src/utils/UserAgentUtils/index.ts:22
+src/utils/UserAgentUtils/index.ts:27
+
+***
+
+### isElectron()
+
+> `static` **isElectron**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/UserAgentUtils/index.ts:18
 
 ***