@sankhyalabs/core-docs 5.20.0-dev.5 → 5.20.0-dev.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (78) hide show
  1. package/README.md +3 -1
  2. package/classes/ApplicationContext.md +31 -32
  3. package/classes/ArrayUtils.md +95 -83
  4. package/classes/AuthorizedServiceCaller.md +25 -34
  5. package/classes/Change.md +59 -74
  6. package/classes/DataUnit.md +1017 -1091
  7. package/classes/DataUnitAction.md +25 -42
  8. package/classes/DataUnitStorage.md +40 -43
  9. package/classes/DateUtils.md +133 -126
  10. package/classes/ElementIDUtils.md +123 -122
  11. package/classes/ErrorException.md +67 -88
  12. package/classes/ErrorTracking.md +20 -23
  13. package/classes/FieldComparator.md +35 -39
  14. package/classes/FloatingManager.md +195 -198
  15. package/classes/HTMLBuilder.md +14 -20
  16. package/classes/HttpProvider.md +45 -41
  17. package/classes/IDBRepository.md +179 -196
  18. package/classes/JSUtils.md +65 -66
  19. package/classes/KeyboardManager.md +95 -87
  20. package/classes/{MaskFormatter-1.md → MaskFormatter.md} +81 -120
  21. package/classes/NumberUtils.md +163 -152
  22. package/classes/ObjectUtils.md +66 -71
  23. package/classes/OnboardingUtils.md +36 -51
  24. package/classes/PromiseSync.md +25 -42
  25. package/classes/ReadyUtil.md +31 -41
  26. package/classes/RequestMetadata.md +29 -30
  27. package/classes/SearchUtils.md +18 -20
  28. package/classes/SelectionInfo.md +59 -74
  29. package/classes/SkwHttpProvider.md +33 -45
  30. package/classes/StringUtils.md +297 -322
  31. package/classes/TimeFormatter.md +43 -44
  32. package/classes/UserAgentUtils.md +17 -20
  33. package/classes/VersionUtils.md +15 -18
  34. package/classes/WaitingChangeException.md +63 -84
  35. package/classes/WarningException.md +67 -88
  36. package/enumerations/Action.md +297 -0
  37. package/enumerations/ChangeOperation.md +47 -0
  38. package/enumerations/DataType.md +57 -0
  39. package/enumerations/DependencyType.md +37 -0
  40. package/enumerations/SelectionMode.md +27 -0
  41. package/enumerations/SortMode.md +27 -0
  42. package/enumerations/UserInterface.md +177 -0
  43. package/functions/defaultDataLoader.md +25 -0
  44. package/{modules.md → globals.md} +17 -39
  45. package/interfaces/ChildDescriptor.md +12 -16
  46. package/interfaces/ChildLink.md +9 -12
  47. package/interfaces/DUActionInterceptor.md +10 -14
  48. package/interfaces/ExecutionContext.md +17 -32
  49. package/interfaces/FieldDescriptor.md +52 -66
  50. package/interfaces/Filter.md +13 -17
  51. package/interfaces/IElementIDInfo.md +11 -14
  52. package/interfaces/ILoadResult.md +11 -16
  53. package/interfaces/IRepository.md +88 -93
  54. package/interfaces/IRepositoryIndex.md +23 -30
  55. package/interfaces/LoadDataRequest.md +36 -45
  56. package/interfaces/LoadDataResponse.md +11 -14
  57. package/interfaces/PageRequest.md +16 -20
  58. package/interfaces/PaginationInfo.md +24 -31
  59. package/interfaces/PromiseSyncCallback.md +13 -17
  60. package/interfaces/QuickFilter.md +17 -21
  61. package/interfaces/Record.md +26 -33
  62. package/interfaces/SavedRecord.md +33 -41
  63. package/interfaces/Sort.md +12 -16
  64. package/interfaces/SortingProvider.md +10 -13
  65. package/interfaces/UnitMetadata.md +16 -21
  66. package/interfaces/WaitingChange.md +16 -20
  67. package/namespaces/MaskFormatter/README.md +17 -0
  68. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +13 -0
  69. package/namespaces/MaskFormatter/variables/MaskCharacter.md +13 -0
  70. package/package.json +1 -1
  71. package/enums/Action.md +0 -305
  72. package/enums/ChangeOperation.md +0 -52
  73. package/enums/DataType.md +0 -63
  74. package/enums/DependencyType.md +0 -41
  75. package/enums/SelectionMode.md +0 -30
  76. package/enums/SortMode.md +0 -30
  77. package/enums/UserInterface.md +0 -195
  78. package/modules/MaskFormatter.md +0 -37
package/classes/DataUnitAction.md CHANGED
@@ -1,4 +1,8 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DataUnitAction
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / DataUnitAction
2
6
 
3
7
  # Class: DataUnitAction
4
8
 
@@ -6,36 +10,23 @@
6
10
 
7
11
  - `StateAction`
8
12
 
9
- ## Table of contents
10
-
11
- ### Constructors
12
-
13
- - [constructor](DataUnitAction.md#constructor)
14
-
15
- ### Properties
16
-
17
- - [\_payload](DataUnitAction.md#_payload)
18
- - [\_type](DataUnitAction.md#_type)
13
+ ## Constructors
19
14
 
20
- ### Accessors
15
+ ### new DataUnitAction()
21
16
 
22
- - [payload](DataUnitAction.md#payload)
23
- - [type](DataUnitAction.md#type)
17
+ > **new DataUnitAction**(`type`, `payload`?): [`DataUnitAction`](DataUnitAction.md)
24
18
 
25
- ## Constructors
19
+ #### Parameters
26
20
 
27
- ### constructor
21
+ • **type**: [`Action`](../enumerations/Action.md)
28
22
 
29
- • **new DataUnitAction**(`type`, `payload?`)
23
+ • **payload?**: `any`
30
24
 
31
- #### Parameters
25
+ #### Returns
32
26
 
33
- | Name | Type |
34
- | :------ | :------ |
35
- | `type` | [`Action`](../enums/Action.md) |
36
- | `payload?` | `any` |
27
+ [`DataUnitAction`](DataUnitAction.md)
37
28
 
38
- #### Defined in
29
+ #### Source
39
30
 
40
31
  src/dataunit/state/action/DataUnitAction.ts:9
41
32
 
@@ -43,19 +34,19 @@ src/dataunit/state/action/DataUnitAction.ts:9
43
34
 
44
35
  ### \_payload
45
36
 
46
- • `Private` **\_payload**: `any`
37
+ > `private` **\_payload**: `any`
47
38
 
48
- #### Defined in
39
+ #### Source
49
40
 
50
41
  src/dataunit/state/action/DataUnitAction.ts:7
51
42
 
52
- ___
43
+ ***
53
44
 
54
45
  ### \_type
55
46
 
56
- • `Private` **\_type**: [`Action`](../enums/Action.md)
47
+ > `private` **\_type**: [`Action`](../enumerations/Action.md)
57
48
 
58
- #### Defined in
49
+ #### Source
59
50
 
60
51
  src/dataunit/state/action/DataUnitAction.ts:6
61
52
 
@@ -63,34 +54,26 @@ src/dataunit/state/action/DataUnitAction.ts:6
63
54
 
64
55
  ### payload
65
56
 
66
- • `get` **payload**(): `any`
57
+ > `get` **payload**(): `any`
67
58
 
68
59
  #### Returns
69
60
 
70
61
  `any`
71
62
 
72
- #### Implementation of
73
-
74
- StateAction.payload
75
-
76
- #### Defined in
63
+ #### Source
77
64
 
78
65
  src/dataunit/state/action/DataUnitAction.ts:18
79
66
 
80
- ___
67
+ ***
81
68
 
82
69
  ### type
83
70
 
84
- • `get` **type**(): [`Action`](../enums/Action.md)
71
+ > `get` **type**(): [`Action`](../enumerations/Action.md)
85
72
 
86
73
  #### Returns
87
74
 
88
- [`Action`](../enums/Action.md)
89
-
90
- #### Implementation of
91
-
92
- StateAction.type
75
+ [`Action`](../enumerations/Action.md)
93
76
 
94
- #### Defined in
77
+ #### Source
95
78
 
96
79
  src/dataunit/state/action/DataUnitAction.ts:14
package/classes/DataUnitStorage.md CHANGED
@@ -1,65 +1,62 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DataUnitStorage
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
2
 
3
- # Class: DataUnitStorage
3
+ ***
4
4
 
5
- Classe responsável por armazenar instâncias de DataUnit.
5
+ [@sankhyalabs/core](../globals.md) / DataUnitStorage
6
6
 
7
- ## Table of contents
7
+ # Class: DataUnitStorage
8
8
 
9
- ### Constructors
9
+ Classe responsável por armazenar instâncias de DataUnit.
10
10
 
11
- - [constructor](DataUnitStorage.md#constructor)
11
+ ## Constructors
12
12
 
13
- ### Properties
13
+ ### new DataUnitStorage()
14
14
 
15
- - [dataUnitMap](DataUnitStorage.md#dataunitmap)
16
- - [keyMap](DataUnitStorage.md#keymap)
15
+ > **new DataUnitStorage**(): [`DataUnitStorage`](DataUnitStorage.md)
17
16
 
18
- ### Methods
17
+ #### Returns
19
18
 
20
- - [get](DataUnitStorage.md#get)
21
- - [put](DataUnitStorage.md#put)
22
- - [remove](DataUnitStorage.md#remove)
19
+ [`DataUnitStorage`](DataUnitStorage.md)
23
20
 
24
- ## Constructors
21
+ ## Properties
25
22
 
26
- ### constructor
23
+ ### dataUnitMap
27
24
 
28
- • **new DataUnitStorage**()
25
+ > `static` `private` **dataUnitMap**: `WeakMap`\<`object`, [`DataUnit`](DataUnit.md)\>
29
26
 
30
- ## Properties
27
+ #### Type declaration
31
28
 
32
- ### dataUnitMap
29
+ ##### key
33
30
 
34
- ▪ `Static` `Private` **dataUnitMap**: `WeakMap`<{ `key`: `string` }, [`DataUnit`](DataUnit.md)\>
31
+ > **key**: `string`
35
32
 
36
- #### Defined in
33
+ #### Source
37
34
 
38
35
  src/dataunit/DataUnitStorage.ts:7
39
36
 
40
- ___
37
+ ***
41
38
 
42
39
  ### keyMap
43
40
 
44
- ▪ `Static` `Private` **keyMap**: `Map`<`string`, { `key`: `string` }\>
41
+ > `static` `private` **keyMap**: `Map`\<`string`, `object`\>
45
42
 
46
- #### Defined in
43
+ #### Source
47
44
 
48
45
  src/dataunit/DataUnitStorage.ts:8
49
46
 
50
47
  ## Methods
51
48
 
52
- ### get
49
+ ### get()
53
50
 
54
- ▸ `Static` **get**(`dataUnitName`): `undefined` \| [`DataUnit`](DataUnit.md)
51
+ > `static` **get**(`dataUnitName`): `undefined` \| [`DataUnit`](DataUnit.md)
55
52
 
56
53
  Retorna uma instância de DataUnit armazenada no DataUnitStorage.
57
54
 
58
55
  #### Parameters
59
56
 
60
- | Name | Type | Description |
61
- | :------ | :------ | :------ |
62
- | `dataUnitName` | `string` | O nome do DataUnit. |
57
+ • **dataUnitName**: `string`
58
+
59
+ O nome do DataUnit.
63
60
 
64
61
  #### Returns
65
62
 
@@ -67,50 +64,50 @@ Retorna uma instância de DataUnit armazenada no DataUnitStorage.
67
64
 
68
65
  - A instância do DataUnit ou undefined caso não seja encontrada.
69
66
 
70
- #### Defined in
67
+ #### Source
71
68
 
72
69
  src/dataunit/DataUnitStorage.ts:15
73
70
 
74
- ___
71
+ ***
75
72
 
76
- ### put
73
+ ### put()
77
74
 
78
- ▸ `Static` **put**(`dataUnit`): `void`
75
+ > `static` **put**(`dataUnit`): `void`
79
76
 
80
77
  Armazena uma instância de DataUnit no DataUnitStorage.
81
78
 
82
79
  #### Parameters
83
80
 
84
- | Name | Type | Description |
85
- | :------ | :------ | :------ |
86
- | `dataUnit` | [`DataUnit`](DataUnit.md) | A instância de DataUnit a ser armazenada. |
81
+ • **dataUnit**: [`DataUnit`](DataUnit.md)
82
+
83
+ A instância de DataUnit a ser armazenada.
87
84
 
88
85
  #### Returns
89
86
 
90
87
  `void`
91
88
 
92
- #### Defined in
89
+ #### Source
93
90
 
94
91
  src/dataunit/DataUnitStorage.ts:24
95
92
 
96
- ___
93
+ ***
97
94
 
98
- ### remove
95
+ ### remove()
99
96
 
100
- ▸ `Static` **remove**(`dataUnit`): `void`
97
+ > `static` **remove**(`dataUnit`): `void`
101
98
 
102
99
  Remove uma instância de DataUnit do DataUnitStorage.
103
100
 
104
101
  #### Parameters
105
102
 
106
- | Name | Type | Description |
107
- | :------ | :------ | :------ |
108
- | `dataUnit` | `string` \| [`DataUnit`](DataUnit.md) | A instância de DataUnit ou o nome do DataUnit a ser removido. |
103
+ • **dataUnit**: `string` \| [`DataUnit`](DataUnit.md)
104
+
105
+ A instância de DataUnit ou o nome do DataUnit a ser removido.
109
106
 
110
107
  #### Returns
111
108
 
112
109
  `void`
113
110
 
114
- #### Defined in
111
+ #### Source
115
112
 
116
113
  src/dataunit/DataUnitStorage.ts:34