@sankhyalabs/core-docs 5.2.0 → 5.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,91 @@
1
+ [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PromiseSync
2
+
3
+ # Class: PromiseSync<T\>
4
+
5
+ O intuito desta classe é organizar a finalização de várias
6
+ promessas executando determinada ação (callback) com o resultado.
7
+
8
+ ## Type parameters
9
+
10
+ | Name |
11
+ | :------ |
12
+ | `T` |
13
+
14
+ ## Table of contents
15
+
16
+ ### Constructors
17
+
18
+ - [constructor](PromiseSync.md#constructor)
19
+
20
+ ### Properties
21
+
22
+ - [\_callBack](PromiseSync.md#_callback)
23
+ - [\_promises](PromiseSync.md#_promises)
24
+
25
+ ### Methods
26
+
27
+ - [add](PromiseSync.md#add)
28
+
29
+ ## Constructors
30
+
31
+ ### constructor
32
+
33
+ • **new PromiseSync**<`T`\>(`callBack`)
34
+
35
+ #### Type parameters
36
+
37
+ | Name |
38
+ | :------ |
39
+ | `T` |
40
+
41
+ #### Parameters
42
+
43
+ | Name | Type |
44
+ | :------ | :------ |
45
+ | `callBack` | [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)<`T`\> |
46
+
47
+ #### Defined in
48
+
49
+ src/async/PromiseSync.ts:13
50
+
51
+ ## Properties
52
+
53
+ ### \_callBack
54
+
55
+ • **\_callBack**: [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)<`T`\>
56
+
57
+ #### Defined in
58
+
59
+ src/async/PromiseSync.ts:8
60
+
61
+ ___
62
+
63
+ ### \_promises
64
+
65
+ • **\_promises**: `Promise`<`T`\>[]
66
+
67
+ #### Defined in
68
+
69
+ src/async/PromiseSync.ts:7
70
+
71
+ ## Methods
72
+
73
+ ### add
74
+
75
+ ▸ **add**(`promise`): `void`
76
+
77
+ Adiciona na lista de promises pendentes. Isso faz com que criemos uma nova espera.
78
+
79
+ #### Parameters
80
+
81
+ | Name | Type | Description |
82
+ | :------ | :------ | :------ |
83
+ | `promise` | `Promise`<`T`\> | Entrará na lista aguardada. |
84
+
85
+ #### Returns
86
+
87
+ `void`
88
+
89
+ #### Defined in
90
+
91
+ src/async/PromiseSync.ts:23
@@ -0,0 +1,39 @@
1
+ [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PromiseSyncCallback
2
+
3
+ # Interface: PromiseSyncCallback<T\>
4
+
5
+ Representa o callback de um sincronizador `PromiseSync<T>`.
6
+
7
+ ## Type parameters
8
+
9
+ | Name |
10
+ | :------ |
11
+ | `T` |
12
+
13
+ ## Table of contents
14
+
15
+ ### Methods
16
+
17
+ - [resolve](PromiseSyncCallback.md#resolve)
18
+
19
+ ## Methods
20
+
21
+ ### resolve
22
+
23
+ ▸ **resolve**(`result`): `void`
24
+
25
+ Será chamado sempre que todas as promessas adicionadas finalizarem.
26
+
27
+ #### Parameters
28
+
29
+ | Name | Type | Description |
30
+ | :------ | :------ | :------ |
31
+ | `result` | `PromiseSettledResult`<`Awaited`<`T`\>\>[] | A lista com o resultado de todas as promises aguardadas. |
32
+
33
+ #### Returns
34
+
35
+ `void`
36
+
37
+ #### Defined in
38
+
39
+ src/async/PromiseSync.ts:48
package/modules.md CHANGED
@@ -38,6 +38,7 @@
38
38
  - [NumberUtils](classes/NumberUtils.md)
39
39
  - [ObjectUtils](classes/ObjectUtils.md)
40
40
  - [OnboardingUtils](classes/OnboardingUtils.md)
41
+ - [PromiseSync](classes/PromiseSync.md)
41
42
  - [ReadyUtil](classes/ReadyUtil.md)
42
43
  - [RequestMetadata](classes/RequestMetadata.md)
43
44
  - [SelectionInfo](classes/SelectionInfo.md)
@@ -62,6 +63,7 @@
62
63
  - [LoadDataResponse](interfaces/LoadDataResponse.md)
63
64
  - [PageRequest](interfaces/PageRequest.md)
64
65
  - [PaginationInfo](interfaces/PaginationInfo.md)
66
+ - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
65
67
  - [QuickFilter](interfaces/QuickFilter.md)
66
68
  - [Record](interfaces/Record.md)
67
69
  - [SavedRecord](interfaces/SavedRecord.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "5.2.0",
3
+ "version": "5.3.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [