@sankhyalabs/core-docs 5.20.0-dev.4 → 5.20.0-dev.6

package/classes/ErrorException.md

@@ -1,205 +1,184 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ErrorException
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / ErrorException
 
 # Class: ErrorException
 
 `ErrorException`: Exceção lançada quando ocorre um erro.
 
-## Hierarchy
+## Extends
 
 - `Error`
 
-  ↳ **`ErrorException`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](ErrorException.md#constructor)
-
-### Properties
+## Constructors
 
-- [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)
+### new ErrorException()
 
-### Methods
+> **new ErrorException**(`title`, `message`, `errorCode`): [`ErrorException`](ErrorException.md)
 
-- [captureStackTrace](ErrorException.md#capturestacktrace)
+#### Parameters
 
-## Constructors
+• **title**: `string`
 
-### constructor
+• **message**: `string`
 
-• **new ErrorException**(`title`, `message`, `errorCode?`)
+• **errorCode**: `string`= `""`
 
-#### Parameters
+#### Returns
 
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `title` | `string` | `undefined` |
-| `message` | `string` | `undefined` |
-| `errorCode` | `string` | `""` |
+[`ErrorException`](ErrorException.md)
 
 #### Overrides
 
-Error.constructor
+`Error.constructor`
 
-#### Defined in
+#### Source
 
 src/exceptions/ErrorException.ts:18
 
 ## Properties
 
-### cause
+### cause?
 
-• `Optional` **cause**: `unknown`
+> `optional` **cause**: `unknown`
 
 #### Inherited from
 
-Error.cause
+`Error.cause`
 
-#### Defined in
+#### Source
 
-node_modules/typescript/lib/lib.es2022.error.d.ts:26
+node\_modules/typescript/lib/lib.es2022.error.d.ts:26
 
-___
+***
 
 ### errorCode
 
-• **errorCode**: `string`
+> **errorCode**: `string`
 
 Código do erro, indica o erro disparado pelo backend.
 
-#### Defined in
+#### Source
 
 src/exceptions/ErrorException.ts:16
 
-___
+***
 
 ### message
 
-• **message**: `string`
+> **message**: `string`
 
 Descrição do erro.
 
 #### Overrides
 
-Error.message
+`Error.message`
 
-#### Defined in
+#### Source
 
 src/exceptions/ErrorException.ts:13
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 Nome da exceção.
 
 #### Overrides
 
-Error.name
+`Error.name`
 
-#### Defined in
+#### Source
 
 src/exceptions/ErrorException.ts:7
 
-___
+***
 
-### stack
+### stack?
 
-• `Optional` **stack**: `string`
+> `optional` **stack**: `string`
 
 #### Inherited from
 
-Error.stack
+`Error.stack`
 
-#### Defined in
+#### Source
 
-node_modules/typescript/lib/lib.es5.d.ts:1055
+node\_modules/typescript/lib/lib.es5.d.ts:1055
 
-___
+***
 
 ### title
 
-• **title**: `string`
+> **title**: `string`
 
 Titulo do erro.
 
-#### Defined in
+#### Source
 
 src/exceptions/ErrorException.ts:10
 
-___
-
-### prepareStackTrace
+***
 
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+### prepareStackTrace()?
 
-#### Type declaration
-
-▸ (`err`, `stackTraces`): `any`
+> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
 
 Optional override for formatting stack traces
 
-**`See`**
+#### See
 
 https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
-##### Parameters
+#### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
+• **err**: `Error`
 
-##### Returns
+• **stackTraces**: `CallSite`[]
+
+#### Returns
 
 `any`
 
 #### Inherited from
 
-Error.prepareStackTrace
+`Error.prepareStackTrace`
 
-#### Defined in
+#### Source
 
-node_modules/@types/node/globals.d.ts:11
+node\_modules/@types/node/globals.d.ts:27
 
-___
+***
 
 ### stackTraceLimit
 
-▪ `Static` **stackTraceLimit**: `number`
+> `static` **stackTraceLimit**: `number`
 
 #### Inherited from
 
-Error.stackTraceLimit
+`Error.stackTraceLimit`
 
-#### Defined in
+#### Source
 
-node_modules/@types/node/globals.d.ts:13
+node\_modules/@types/node/globals.d.ts:29
 
 ## Methods
 
-### captureStackTrace
+### captureStackTrace()
 
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
 
 Create .stack property on a target object
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
+• **targetObject**: `object`
+
+• **constructorOpt?**: `Function`
 
 #### Returns
 
@@ -207,8 +186,8 @@ Create .stack property on a target object
 
 #### Inherited from
 
-Error.captureStackTrace
+`Error.captureStackTrace`
 
-#### Defined in
+#### Source
 
-node_modules/@types/node/globals.d.ts:4
+node\_modules/@types/node/globals.d.ts:20

package/classes/ErrorTracking.md

@@ -1,31 +1,28 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ErrorTracking
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: ErrorTracking
-
-`ErrorTracking`: Handler para processar exceptions lançadas.
+***
 
-## Table of contents
+[@sankhyalabs/core](../globals.md) / ErrorTracking
 
-### Constructors
+# Class: ErrorTracking
 
-- [constructor](ErrorTracking.md#constructor)
+`ErrorTracking`: Handler para processar exceptions lançadas.
 
-### Methods
+## Constructors
 
-- [init](ErrorTracking.md#init)
-- [isInternalException](ErrorTracking.md#isinternalexception)
+### new ErrorTracking()
 
-## Constructors
+> **new ErrorTracking**(): [`ErrorTracking`](ErrorTracking.md)
 
-### constructor
+#### Returns
 
-• **new ErrorTracking**()
+[`ErrorTracking`](ErrorTracking.md)
 
 ## Methods
 
-### init
+### init()
 
-▸ `Static` **init**(): `void`
+> `static` **init**(): `void`
 
 Inicializa o Rollbar, utilizado para rastreio de erros e análise de logs.
 
@@ -33,23 +30,23 @@ Inicializa o Rollbar, utilizado para rastreio de erros e análise de logs.
 
 `void`
 
-#### Defined in
+#### Source
 
 src/traking/ErrorTraking.ts:16
 
-___
+***
 
-### isInternalException
+### isInternalException()
 
-▸ `Static` `Private` **isInternalException**(`error`): `boolean`
+> `static` `private` **isInternalException**(`error`): `boolean`
 
 Retorna se o erro é uma exceção interna na aplicação.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `error` | `any` | Erro que será identificado como exceção interna ou não. |
+• **error**: `any`
+
+Erro que será identificado como exceção interna ou não.
 
 #### Returns
 
@@ -57,6 +54,6 @@ Retorna se o erro é uma exceção interna na aplicação.
 
 - Verdadeiro caso seja uma exceção interna.
 
-#### Defined in
+#### Source
 
 src/traking/ErrorTraking.ts:34

package/classes/FieldComparator.md

@@ -1,87 +1,83 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / FieldComparator
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: FieldComparator
-
-## Table of contents
+***
 
-### Constructors
+[@sankhyalabs/core](../globals.md) / FieldComparator
 
-- [constructor](FieldComparator.md#constructor)
+# Class: FieldComparator
 
-### Methods
+## Constructors
 
-- [compare](FieldComparator.md#compare)
-- [compareUndefined](FieldComparator.md#compareundefined)
-- [compareValues](FieldComparator.md#comparevalues)
+### new FieldComparator()
 
-## Constructors
+> **new FieldComparator**(): [`FieldComparator`](FieldComparator.md)
 
-### constructor
+#### Returns
 
-• **new FieldComparator**()
+[`FieldComparator`](FieldComparator.md)
 
 ## Methods
 
-### compare
+### compare()
 
-▸ `Static` **compare**(`field`, `recordA`, `recordB`, `asc?`): `number`
+> `static` **compare**(`field`, `recordA`, `recordB`, `asc`): `number`
 
 #### Parameters
 
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `field` | [`FieldDescriptor`](../interfaces/FieldDescriptor.md) | `undefined` |
-| `recordA` | [`Record`](../interfaces/Record.md) | `undefined` |
-| `recordB` | [`Record`](../interfaces/Record.md) | `undefined` |
-| `asc` | `boolean` | `true` |
+• **field**: [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
+
+• **recordA**: [`Record`](../interfaces/Record.md)
+
+• **recordB**: [`Record`](../interfaces/Record.md)
+
+• **asc**: `boolean`= `true`
 
 #### Returns
 
 `number`
 
-#### Defined in
+#### Source
 
 src/dataunit/sorting/FieldComparator.ts:7
 
-___
+***
 
-### compareUndefined
+### compareUndefined()
 
-▸ `Static` **compareUndefined**(`isUndefinedA`, `isUndefinedB`): `undefined` \| `number`
+> `static` **compareUndefined**(`isUndefinedA`, `isUndefinedB`): `undefined` \| `number`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `isUndefinedA` | `boolean` |
-| `isUndefinedB` | `boolean` |
+• **isUndefinedA**: `boolean`
+
+• **isUndefinedB**: `boolean`
 
 #### Returns
 
 `undefined` \| `number`
 
-#### Defined in
+#### Source
 
 src/dataunit/sorting/FieldComparator.ts:26
 
-___
+***
 
-### compareValues
+### compareValues()
 
-▸ `Static` **compareValues**(`descriptor`, `valueA`, `valueB`): `number`
+> `static` **compareValues**(`descriptor`, `valueA`, `valueB`): `number`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `descriptor` | [`FieldDescriptor`](../interfaces/FieldDescriptor.md) |
-| `valueA` | `any` |
-| `valueB` | `any` |
+• **descriptor**: [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
+
+• **valueA**: `any`
+
+• **valueB**: `any`
 
 #### Returns
 
 `number`
 
-#### Defined in
+#### Source
 
 src/dataunit/sorting/FieldComparator.ts:16