@sankhyalabs/core-docs 0.0.0-bugfix-rc-KB-2229.0 → 0.0.0-feat-dev-kb-15253.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.
- package/classes/FieldComparator.md +64 -0
- package/classes/IDBRepository.md +366 -0
- package/enums/DataType.md +5 -5
- package/interfaces/ILoadResult.md +36 -0
- package/modules.md +3 -0
- package/package.json +1 -1
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / FieldComparator
|
|
2
|
+
|
|
3
|
+
# Class: FieldComparator
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Constructors
|
|
8
|
+
|
|
9
|
+
- [constructor](FieldComparator.md#constructor)
|
|
10
|
+
|
|
11
|
+
### Methods
|
|
12
|
+
|
|
13
|
+
- [compare](FieldComparator.md#compare)
|
|
14
|
+
- [compareUndefined](FieldComparator.md#compareundefined)
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
### constructor
|
|
19
|
+
|
|
20
|
+
• **new FieldComparator**()
|
|
21
|
+
|
|
22
|
+
## Methods
|
|
23
|
+
|
|
24
|
+
### compare
|
|
25
|
+
|
|
26
|
+
▸ `Static` **compare**(`field`, `recordA`, `recordB`, `asc?`): `number`
|
|
27
|
+
|
|
28
|
+
#### Parameters
|
|
29
|
+
|
|
30
|
+
| Name | Type | Default value |
|
|
31
|
+
| :------ | :------ | :------ |
|
|
32
|
+
| `field` | [`FieldDescriptor`](../interfaces/FieldDescriptor.md) | `undefined` |
|
|
33
|
+
| `recordA` | [`Record`](../interfaces/Record.md) | `undefined` |
|
|
34
|
+
| `recordB` | [`Record`](../interfaces/Record.md) | `undefined` |
|
|
35
|
+
| `asc` | `boolean` | `true` |
|
|
36
|
+
|
|
37
|
+
#### Returns
|
|
38
|
+
|
|
39
|
+
`number`
|
|
40
|
+
|
|
41
|
+
#### Defined in
|
|
42
|
+
|
|
43
|
+
src/dataunit/sorting/FieldComparator.ts:7
|
|
44
|
+
|
|
45
|
+
___
|
|
46
|
+
|
|
47
|
+
### compareUndefined
|
|
48
|
+
|
|
49
|
+
▸ `Static` `Private` **compareUndefined**(`isUndefinedA`, `isUndefinedB`): `undefined` \| `number`
|
|
50
|
+
|
|
51
|
+
#### Parameters
|
|
52
|
+
|
|
53
|
+
| Name | Type |
|
|
54
|
+
| :------ | :------ |
|
|
55
|
+
| `isUndefinedA` | `boolean` |
|
|
56
|
+
| `isUndefinedB` | `boolean` |
|
|
57
|
+
|
|
58
|
+
#### Returns
|
|
59
|
+
|
|
60
|
+
`undefined` \| `number`
|
|
61
|
+
|
|
62
|
+
#### Defined in
|
|
63
|
+
|
|
64
|
+
src/dataunit/sorting/FieldComparator.ts:21
|
|
@@ -0,0 +1,366 @@
|
|
|
1
|
+
[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IDBRepository
|
|
2
|
+
|
|
3
|
+
# Class: IDBRepository<T\>
|
|
4
|
+
|
|
5
|
+
Abstração para simplificar o uso do indexed DB
|
|
6
|
+
|
|
7
|
+
Além de facilitar os comandos de incluir, remover alterar e obter
|
|
8
|
+
objetos, esse repositório preserva a ordem de inserção na lista,
|
|
9
|
+
além de permitir filtros e ordenações compostas
|
|
10
|
+
(impossíveis com uso de índices).
|
|
11
|
+
|
|
12
|
+
## Type parameters
|
|
13
|
+
|
|
14
|
+
| Name |
|
|
15
|
+
| :------ |
|
|
16
|
+
| `T` |
|
|
17
|
+
|
|
18
|
+
## Table of contents
|
|
19
|
+
|
|
20
|
+
### Constructors
|
|
21
|
+
|
|
22
|
+
- [constructor](IDBRepository.md#constructor)
|
|
23
|
+
|
|
24
|
+
### Properties
|
|
25
|
+
|
|
26
|
+
- [\_addedStoreName](IDBRepository.md#_addedstorename)
|
|
27
|
+
- [\_db](IDBRepository.md#_db)
|
|
28
|
+
- [\_dbName](IDBRepository.md#_dbname)
|
|
29
|
+
- [\_dbVersion](IDBRepository.md#_dbversion)
|
|
30
|
+
- [\_indexKeyPath](IDBRepository.md#_indexkeypath)
|
|
31
|
+
- [\_storeName](IDBRepository.md#_storename)
|
|
32
|
+
|
|
33
|
+
### Methods
|
|
34
|
+
|
|
35
|
+
- [clear](IDBRepository.md#clear)
|
|
36
|
+
- [delete](IDBRepository.md#delete)
|
|
37
|
+
- [getAddedItems](IDBRepository.md#getaddeditems)
|
|
38
|
+
- [getItemPosition](IDBRepository.md#getitemposition)
|
|
39
|
+
- [getItemPositionByAdded](IDBRepository.md#getitempositionbyadded)
|
|
40
|
+
- [insert](IDBRepository.md#insert)
|
|
41
|
+
- [isEmpty](IDBRepository.md#isempty)
|
|
42
|
+
- [load](IDBRepository.md#load)
|
|
43
|
+
- [openDB](IDBRepository.md#opendb)
|
|
44
|
+
- [push](IDBRepository.md#push)
|
|
45
|
+
- [update](IDBRepository.md#update)
|
|
46
|
+
|
|
47
|
+
## Constructors
|
|
48
|
+
|
|
49
|
+
### constructor
|
|
50
|
+
|
|
51
|
+
• **new IDBRepository**<`T`\>(`dbName`, `dbVersion`, `storeName`, `indexKeyPath`)
|
|
52
|
+
|
|
53
|
+
Construtor padrão
|
|
54
|
+
|
|
55
|
+
#### Type parameters
|
|
56
|
+
|
|
57
|
+
| Name |
|
|
58
|
+
| :------ |
|
|
59
|
+
| `T` |
|
|
60
|
+
|
|
61
|
+
#### Parameters
|
|
62
|
+
|
|
63
|
+
| Name | Type | Description |
|
|
64
|
+
| :------ | :------ | :------ |
|
|
65
|
+
| `dbName` | `string` | Nome do DB |
|
|
66
|
+
| `dbVersion` | `number` | Versão do DB |
|
|
67
|
+
| `storeName` | `string` | Nome da store |
|
|
68
|
+
| `indexKeyPath` | `string` | Um atributo que identifique os objetos guardados |
|
|
69
|
+
|
|
70
|
+
#### Defined in
|
|
71
|
+
|
|
72
|
+
src/indexeddb/IDBRepository.ts:31
|
|
73
|
+
|
|
74
|
+
## Properties
|
|
75
|
+
|
|
76
|
+
### \_addedStoreName
|
|
77
|
+
|
|
78
|
+
• `Private` **\_addedStoreName**: `string`
|
|
79
|
+
|
|
80
|
+
#### Defined in
|
|
81
|
+
|
|
82
|
+
src/indexeddb/IDBRepository.ts:19
|
|
83
|
+
|
|
84
|
+
___
|
|
85
|
+
|
|
86
|
+
### \_db
|
|
87
|
+
|
|
88
|
+
• `Private` `Optional` **\_db**: `IDBPDatabase`<`unknown`\>
|
|
89
|
+
|
|
90
|
+
#### Defined in
|
|
91
|
+
|
|
92
|
+
src/indexeddb/IDBRepository.ts:21
|
|
93
|
+
|
|
94
|
+
___
|
|
95
|
+
|
|
96
|
+
### \_dbName
|
|
97
|
+
|
|
98
|
+
• `Private` **\_dbName**: `string`
|
|
99
|
+
|
|
100
|
+
#### Defined in
|
|
101
|
+
|
|
102
|
+
src/indexeddb/IDBRepository.ts:16
|
|
103
|
+
|
|
104
|
+
___
|
|
105
|
+
|
|
106
|
+
### \_dbVersion
|
|
107
|
+
|
|
108
|
+
• `Private` **\_dbVersion**: `number`
|
|
109
|
+
|
|
110
|
+
#### Defined in
|
|
111
|
+
|
|
112
|
+
src/indexeddb/IDBRepository.ts:17
|
|
113
|
+
|
|
114
|
+
___
|
|
115
|
+
|
|
116
|
+
### \_indexKeyPath
|
|
117
|
+
|
|
118
|
+
• `Private` **\_indexKeyPath**: `string`
|
|
119
|
+
|
|
120
|
+
#### Defined in
|
|
121
|
+
|
|
122
|
+
src/indexeddb/IDBRepository.ts:20
|
|
123
|
+
|
|
124
|
+
___
|
|
125
|
+
|
|
126
|
+
### \_storeName
|
|
127
|
+
|
|
128
|
+
• `Private` **\_storeName**: `string`
|
|
129
|
+
|
|
130
|
+
#### Defined in
|
|
131
|
+
|
|
132
|
+
src/indexeddb/IDBRepository.ts:18
|
|
133
|
+
|
|
134
|
+
## Methods
|
|
135
|
+
|
|
136
|
+
### clear
|
|
137
|
+
|
|
138
|
+
▸ **clear**(): `Promise`<`void`\>
|
|
139
|
+
|
|
140
|
+
Limpa todo o repositório
|
|
141
|
+
|
|
142
|
+
#### Returns
|
|
143
|
+
|
|
144
|
+
`Promise`<`void`\>
|
|
145
|
+
|
|
146
|
+
Promessa de execução
|
|
147
|
+
|
|
148
|
+
#### Defined in
|
|
149
|
+
|
|
150
|
+
src/indexeddb/IDBRepository.ts:113
|
|
151
|
+
|
|
152
|
+
___
|
|
153
|
+
|
|
154
|
+
### delete
|
|
155
|
+
|
|
156
|
+
▸ **delete**(`items`): `Promise`<`void`\>
|
|
157
|
+
|
|
158
|
+
Remove itens do repositório
|
|
159
|
+
|
|
160
|
+
#### Parameters
|
|
161
|
+
|
|
162
|
+
| Name | Type | Description |
|
|
163
|
+
| :------ | :------ | :------ |
|
|
164
|
+
| `items` | `T`[] | Os itens a serem removidos |
|
|
165
|
+
|
|
166
|
+
#### Returns
|
|
167
|
+
|
|
168
|
+
`Promise`<`void`\>
|
|
169
|
+
|
|
170
|
+
Promessa de execução
|
|
171
|
+
|
|
172
|
+
#### Defined in
|
|
173
|
+
|
|
174
|
+
src/indexeddb/IDBRepository.ts:134
|
|
175
|
+
|
|
176
|
+
___
|
|
177
|
+
|
|
178
|
+
### getAddedItems
|
|
179
|
+
|
|
180
|
+
▸ `Private` **getAddedItems**(`db`): `Promise`<`AddedItem`<`T`\>[]\>
|
|
181
|
+
|
|
182
|
+
#### Parameters
|
|
183
|
+
|
|
184
|
+
| Name | Type |
|
|
185
|
+
| :------ | :------ |
|
|
186
|
+
| `db` | `IDBPDatabase`<`unknown`\> |
|
|
187
|
+
|
|
188
|
+
#### Returns
|
|
189
|
+
|
|
190
|
+
`Promise`<`AddedItem`<`T`\>[]\>
|
|
191
|
+
|
|
192
|
+
#### Defined in
|
|
193
|
+
|
|
194
|
+
src/indexeddb/IDBRepository.ts:303
|
|
195
|
+
|
|
196
|
+
___
|
|
197
|
+
|
|
198
|
+
### getItemPosition
|
|
199
|
+
|
|
200
|
+
▸ `Private` **getItemPosition**(`db`, `itemTest`): `Promise`<`number`\>
|
|
201
|
+
|
|
202
|
+
#### Parameters
|
|
203
|
+
|
|
204
|
+
| Name | Type |
|
|
205
|
+
| :------ | :------ |
|
|
206
|
+
| `db` | `IDBPDatabase`<`unknown`\> |
|
|
207
|
+
| `itemTest` | (`item`: `any`) => `boolean` |
|
|
208
|
+
|
|
209
|
+
#### Returns
|
|
210
|
+
|
|
211
|
+
`Promise`<`number`\>
|
|
212
|
+
|
|
213
|
+
#### Defined in
|
|
214
|
+
|
|
215
|
+
src/indexeddb/IDBRepository.ts:268
|
|
216
|
+
|
|
217
|
+
___
|
|
218
|
+
|
|
219
|
+
### getItemPositionByAdded
|
|
220
|
+
|
|
221
|
+
▸ `Private` **getItemPositionByAdded**(`db`, `itemTest`): `Promise`<`number`\>
|
|
222
|
+
|
|
223
|
+
#### Parameters
|
|
224
|
+
|
|
225
|
+
| Name | Type |
|
|
226
|
+
| :------ | :------ |
|
|
227
|
+
| `db` | `IDBPDatabase`<`unknown`\> |
|
|
228
|
+
| `itemTest` | (`item`: `any`) => `boolean` |
|
|
229
|
+
|
|
230
|
+
#### Returns
|
|
231
|
+
|
|
232
|
+
`Promise`<`number`\>
|
|
233
|
+
|
|
234
|
+
#### Defined in
|
|
235
|
+
|
|
236
|
+
src/indexeddb/IDBRepository.ts:291
|
|
237
|
+
|
|
238
|
+
___
|
|
239
|
+
|
|
240
|
+
### insert
|
|
241
|
+
|
|
242
|
+
▸ **insert**(`itemReference`, `items`): `Promise`<`void`\>
|
|
243
|
+
|
|
244
|
+
Insere itens em uma posição de referência
|
|
245
|
+
|
|
246
|
+
#### Parameters
|
|
247
|
+
|
|
248
|
+
| Name | Type | Description |
|
|
249
|
+
| :------ | :------ | :------ |
|
|
250
|
+
| `itemReference` | `T` | O item posterior aos inseridos |
|
|
251
|
+
| `items` | `T`[] | Os itens a serem inseridos |
|
|
252
|
+
|
|
253
|
+
#### Returns
|
|
254
|
+
|
|
255
|
+
`Promise`<`void`\>
|
|
256
|
+
|
|
257
|
+
Promessa de execução
|
|
258
|
+
|
|
259
|
+
#### Defined in
|
|
260
|
+
|
|
261
|
+
src/indexeddb/IDBRepository.ts:203
|
|
262
|
+
|
|
263
|
+
___
|
|
264
|
+
|
|
265
|
+
### isEmpty
|
|
266
|
+
|
|
267
|
+
▸ **isEmpty**(): `Promise`<`boolean`\>
|
|
268
|
+
|
|
269
|
+
Determina se o repositório está vazio ou ainda não foi criado.
|
|
270
|
+
|
|
271
|
+
#### Returns
|
|
272
|
+
|
|
273
|
+
`Promise`<`boolean`\>
|
|
274
|
+
|
|
275
|
+
#### Defined in
|
|
276
|
+
|
|
277
|
+
src/indexeddb/IDBRepository.ts:226
|
|
278
|
+
|
|
279
|
+
___
|
|
280
|
+
|
|
281
|
+
### load
|
|
282
|
+
|
|
283
|
+
▸ **load**(`filterFunction?`, `sortingFunction?`, `offset?`, `limit?`): `Promise`<[`ILoadResult`](../interfaces/ILoadResult.md)<`T`\>\>
|
|
284
|
+
|
|
285
|
+
Recupera registros do repositório
|
|
286
|
+
|
|
287
|
+
#### Parameters
|
|
288
|
+
|
|
289
|
+
| Name | Type | Description |
|
|
290
|
+
| :------ | :------ | :------ |
|
|
291
|
+
| `filterFunction?` | (`value`: `T`) => `boolean` | Teste para determinar se um registro está no universo desejado |
|
|
292
|
+
| `sortingFunction?` | (`itemA`: `T`, `itemB`: `T`) => `number` | Critério comparação para ordenação |
|
|
293
|
+
| `offset?` | `number` | Determina que o resultado descarta os registros iniciais |
|
|
294
|
+
| `limit?` | `number` | Descarta o resultado a partir de uma quantidade de registros |
|
|
295
|
+
|
|
296
|
+
#### Returns
|
|
297
|
+
|
|
298
|
+
`Promise`<[`ILoadResult`](../interfaces/ILoadResult.md)<`T`\>\>
|
|
299
|
+
|
|
300
|
+
Promessa de um array que satisfaça aos critérios informados
|
|
301
|
+
|
|
302
|
+
#### Defined in
|
|
303
|
+
|
|
304
|
+
src/indexeddb/IDBRepository.ts:48
|
|
305
|
+
|
|
306
|
+
___
|
|
307
|
+
|
|
308
|
+
### openDB
|
|
309
|
+
|
|
310
|
+
▸ `Private` **openDB**(): `Promise`<`IDBPDatabase`<`unknown`\>\>
|
|
311
|
+
|
|
312
|
+
#### Returns
|
|
313
|
+
|
|
314
|
+
`Promise`<`IDBPDatabase`<`unknown`\>\>
|
|
315
|
+
|
|
316
|
+
#### Defined in
|
|
317
|
+
|
|
318
|
+
src/indexeddb/IDBRepository.ts:244
|
|
319
|
+
|
|
320
|
+
___
|
|
321
|
+
|
|
322
|
+
### push
|
|
323
|
+
|
|
324
|
+
▸ **push**(`items`): `Promise`<`void`\>
|
|
325
|
+
|
|
326
|
+
Adiciona registros no final do repositório
|
|
327
|
+
|
|
328
|
+
#### Parameters
|
|
329
|
+
|
|
330
|
+
| Name | Type | Description |
|
|
331
|
+
| :------ | :------ | :------ |
|
|
332
|
+
| `items` | `T`[] | Os items a serem adicionados |
|
|
333
|
+
|
|
334
|
+
#### Returns
|
|
335
|
+
|
|
336
|
+
`Promise`<`void`\>
|
|
337
|
+
|
|
338
|
+
Promessa de execução
|
|
339
|
+
|
|
340
|
+
#### Defined in
|
|
341
|
+
|
|
342
|
+
src/indexeddb/IDBRepository.ts:88
|
|
343
|
+
|
|
344
|
+
___
|
|
345
|
+
|
|
346
|
+
### update
|
|
347
|
+
|
|
348
|
+
▸ **update**(`items`): `Promise`<`void`\>
|
|
349
|
+
|
|
350
|
+
Altera itens já persistido no repositório
|
|
351
|
+
|
|
352
|
+
#### Parameters
|
|
353
|
+
|
|
354
|
+
| Name | Type | Description |
|
|
355
|
+
| :------ | :------ | :------ |
|
|
356
|
+
| `items` | `T`[] | Os itens a serem alterados |
|
|
357
|
+
|
|
358
|
+
#### Returns
|
|
359
|
+
|
|
360
|
+
`Promise`<`void`\>
|
|
361
|
+
|
|
362
|
+
Promessa de execução
|
|
363
|
+
|
|
364
|
+
#### Defined in
|
|
365
|
+
|
|
366
|
+
src/indexeddb/IDBRepository.ts:167
|
package/enums/DataType.md
CHANGED
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
|
|
21
21
|
#### Defined in
|
|
22
22
|
|
|
23
|
-
src/dataunit/metadata/DataType.ts:
|
|
23
|
+
src/dataunit/metadata/DataType.ts:12
|
|
24
24
|
|
|
25
25
|
___
|
|
26
26
|
|
|
@@ -30,7 +30,7 @@ ___
|
|
|
30
30
|
|
|
31
31
|
#### Defined in
|
|
32
32
|
|
|
33
|
-
src/dataunit/metadata/DataType.ts:
|
|
33
|
+
src/dataunit/metadata/DataType.ts:10
|
|
34
34
|
|
|
35
35
|
___
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@ ___
|
|
|
40
40
|
|
|
41
41
|
#### Defined in
|
|
42
42
|
|
|
43
|
-
src/dataunit/metadata/DataType.ts:
|
|
43
|
+
src/dataunit/metadata/DataType.ts:9
|
|
44
44
|
|
|
45
45
|
___
|
|
46
46
|
|
|
@@ -50,7 +50,7 @@ ___
|
|
|
50
50
|
|
|
51
51
|
#### Defined in
|
|
52
52
|
|
|
53
|
-
src/dataunit/metadata/DataType.ts:
|
|
53
|
+
src/dataunit/metadata/DataType.ts:13
|
|
54
54
|
|
|
55
55
|
___
|
|
56
56
|
|
|
@@ -60,4 +60,4 @@ ___
|
|
|
60
60
|
|
|
61
61
|
#### Defined in
|
|
62
62
|
|
|
63
|
-
src/dataunit/metadata/DataType.ts:
|
|
63
|
+
src/dataunit/metadata/DataType.ts:11
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ILoadResult
|
|
2
|
+
|
|
3
|
+
# Interface: ILoadResult<T\>
|
|
4
|
+
|
|
5
|
+
## Type parameters
|
|
6
|
+
|
|
7
|
+
| Name |
|
|
8
|
+
| :------ |
|
|
9
|
+
| `T` |
|
|
10
|
+
|
|
11
|
+
## Table of contents
|
|
12
|
+
|
|
13
|
+
### Properties
|
|
14
|
+
|
|
15
|
+
- [count](ILoadResult.md#count)
|
|
16
|
+
- [result](ILoadResult.md#result)
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
### count
|
|
21
|
+
|
|
22
|
+
• **count**: `number`
|
|
23
|
+
|
|
24
|
+
#### Defined in
|
|
25
|
+
|
|
26
|
+
src/indexeddb/ILoadResult.ts:3
|
|
27
|
+
|
|
28
|
+
___
|
|
29
|
+
|
|
30
|
+
### result
|
|
31
|
+
|
|
32
|
+
• **result**: `T`[]
|
|
33
|
+
|
|
34
|
+
#### Defined in
|
|
35
|
+
|
|
36
|
+
src/indexeddb/ILoadResult.ts:2
|
package/modules.md
CHANGED
|
@@ -31,9 +31,11 @@
|
|
|
31
31
|
- [ElementIDUtils](classes/ElementIDUtils.md)
|
|
32
32
|
- [ErrorException](classes/ErrorException.md)
|
|
33
33
|
- [ErrorTracking](classes/ErrorTracking.md)
|
|
34
|
+
- [FieldComparator](classes/FieldComparator.md)
|
|
34
35
|
- [FloatingManager](classes/FloatingManager.md)
|
|
35
36
|
- [HTMLBuilder](classes/HTMLBuilder.md)
|
|
36
37
|
- [HttpProvider](classes/HttpProvider.md)
|
|
38
|
+
- [IDBRepository](classes/IDBRepository.md)
|
|
37
39
|
- [JSUtils](classes/JSUtils.md)
|
|
38
40
|
- [MaskFormatter](classes/MaskFormatter-1.md)
|
|
39
41
|
- [NumberUtils](classes/NumberUtils.md)
|
|
@@ -60,6 +62,7 @@
|
|
|
60
62
|
- [FieldDescriptor](interfaces/FieldDescriptor.md)
|
|
61
63
|
- [Filter](interfaces/Filter.md)
|
|
62
64
|
- [IElementIDInfo](interfaces/IElementIDInfo.md)
|
|
65
|
+
- [ILoadResult](interfaces/ILoadResult.md)
|
|
63
66
|
- [LoadDataRequest](interfaces/LoadDataRequest.md)
|
|
64
67
|
- [LoadDataResponse](interfaces/LoadDataResponse.md)
|
|
65
68
|
- [PageRequest](interfaces/PageRequest.md)
|