@sankhyalabs/core-docs 0.0.0-hotfix-rc-KB-74140.0 → 0.0.0-hotfix-rc-KB-74140.1

package/classes/LockManager.md

@@ -0,0 +1,191 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / LockManager
+
+# Class: LockManager
+
+## Constructors
+
+### new LockManager()
+
+> **new LockManager**(): [`LockManager`](LockManager.md)
+
+#### Returns
+
+[`LockManager`](LockManager.md)
+
+## Properties
+
+### ATTRIBUTE\_NAME
+
+> `static` **ATTRIBUTE\_NAME**: `string` = `"data-locker-manger-context-id"`
+
+Nome do atributo que será utilizado para controlar contexto de locks nos elementos da DOM.
+
+#### Source
+
+src/utils/LockManager.ts:24
+
+***
+
+### \_locks
+
+> `static` `private` **\_locks**: `Map`\<`string`, `Lock`[]\>
+
+#### Source
+
+src/utils/LockManager.ts:19
+
+## Methods
+
+### addLockManagerCtxId()
+
+> `static` **addLockManagerCtxId**(`startElement`): `string`
+
+Cria um contexto de locker, caso nao exista, para todos elementos pais iniciados com ez- ou snk-.
+
+#### Parameters
+
+• **startElement**: `HTMLElement`
+
+Elemento de de onde o lock deve começar.
+
+#### Returns
+
+`string`
+
+- O id do locker, que pode ser usado para iniciar ou aguardar um lock do contexto.
+
+#### Source
+
+src/utils/LockManager.ts:83
+
+***
+
+### buildContextID()
+
+> `static` `private` **buildContextID**(): `string`
+
+#### Returns
+
+`string`
+
+#### Source
+
+src/utils/LockManager.ts:26
+
+***
+
+### buildLockerID()
+
+> `static` `private` **buildLockerID**(`ctxId`, `operation`): `undefined` \| `string`
+
+#### Parameters
+
+• **ctxId**: `string` \| `HTMLElement`
+
+• **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
+
+#### Returns
+
+`undefined` \| `string`
+
+#### Source
+
+src/utils/LockManager.ts:30
+
+***
+
+### findExistingCtxId()
+
+> `static` `private` **findExistingCtxId**(`element`): `null` \| `string`
+
+#### Parameters
+
+• **element**: `HTMLElement`
+
+#### Returns
+
+`null` \| `string`
+
+#### Source
+
+src/utils/LockManager.ts:43
+
+***
+
+### lock()
+
+> `static` **lock**(`id`, `operation`): `any`
+
+Inicia um locker baseado em um contexto e uma operação.
+
+#### Parameters
+
+• **id**: `string` \| `HTMLElement`
+
+Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
+
+• **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
+
+Operação do contexto que o lock deve ser feito.
+
+#### Returns
+
+`any`
+
+- Uma função que fara a liberação do lock.
+
+#### Source
+
+src/utils/LockManager.ts:114
+
+***
+
+### traverseAndAddAttr()
+
+> `static` `private` **traverseAndAddAttr**(`element`, `ctxId`): `void`
+
+#### Parameters
+
+• **element**: `HTMLElement`
+
+• **ctxId**: `string`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/LockManager.ts:65
+
+***
+
+### whenResolve()
+
+> `static` **whenResolve**(`id`, `operation`): `Promise`\<`void`\>
+
+Aguarda todos os lockers de um contexto e operação serem resolvidos.
+
+#### Parameters
+
+• **id**: `string` \| `HTMLElement`
+
+Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
+
+• **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
+
+Operação do contexto que devera aguardar.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+- Promise que será resolvida quando todos lockers forem finalizados.
+
+#### Source
+
+src/utils/LockManager.ts:142

package/enumerations/LockManagerOperation.md

@@ -0,0 +1,21 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / LockManagerOperation
+
+# Enumeration: LockManagerOperation
+
+Define os tipos de operação que o locker pode controlar
+
+## Enumeration Members
+
+### TASKBAR\_CLICK
+
+> **TASKBAR\_CLICK**: `"taskbar_click"`
+
+Operação de lock utilizada para controlar cliques nos botoes da taskbar.
+
+#### Source
+
+src/utils/LockManager.ts:9

package/globals.md

@@ -14,6 +14,7 @@
 - [ChangeOperation](enumerations/ChangeOperation.md)
 - [DataType](enumerations/DataType.md)
 - [DependencyType](enumerations/DependencyType.md)
+- [LockManagerOperation](enumerations/LockManagerOperation.md)
 - [OverflowDirection](enumerations/OverflowDirection.md)
 - [SelectionMode](enumerations/SelectionMode.md)
 - [SortMode](enumerations/SortMode.md)
@@ -39,6 +40,7 @@
 - [IDBRepository](classes/IDBRepository.md)
 - [JSUtils](classes/JSUtils.md)
 - [KeyboardManager](classes/KeyboardManager.md)
+- [LockManager](classes/LockManager.md)
 - [MaskFormatter](classes/MaskFormatter.md)
 - [NumberUtils](classes/NumberUtils.md)
 - [ObjectUtils](classes/ObjectUtils.md)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sankhyalabs/core-docs",
-    "version": "0.0.0-hotfix-rc-KB-74140.0",
+    "version": "0.0.0-hotfix-rc-KB-74140.1",
     "description": "Documentação da biblioteca de componentes Sankhya.",
     "main": "",
     "files": [