@sankhyalabs/core-docs 2.3.6 → 2.4.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.
@@ -2,6 +2,8 @@
2
2
 
3
3
  # Interface: LoadDataRequest
4
4
 
5
+ Atributos enviados na requisição de carregamento dos registros
6
+
5
7
  ## Table of contents
6
8
 
7
9
  ### Properties
@@ -18,9 +20,11 @@
18
20
 
19
21
  • `Optional` **filters**: [`Filter`](Filter.md)[]
20
22
 
23
+ Filtros
24
+
21
25
  #### Defined in
22
26
 
23
- src/dataunit/loading/LoadDataRequest.ts:8
27
+ src/dataunit/loading/LoadDataRequest.ts:16
24
28
 
25
29
  ___
26
30
 
@@ -28,9 +32,11 @@ ___
28
32
 
29
33
  • `Optional` **limit**: `number`
30
34
 
35
+ Quantidade de registros que será retornado
36
+
31
37
  #### Defined in
32
38
 
33
- src/dataunit/loading/LoadDataRequest.ts:6
39
+ src/dataunit/loading/LoadDataRequest.ts:10
34
40
 
35
41
  ___
36
42
 
@@ -38,9 +44,11 @@ ___
38
44
 
39
45
  • `Optional` **offset**: `number`
40
46
 
47
+ Indice inicial dos registros que será retornado
48
+
41
49
  #### Defined in
42
50
 
43
- src/dataunit/loading/LoadDataRequest.ts:5
51
+ src/dataunit/loading/LoadDataRequest.ts:7
44
52
 
45
53
  ___
46
54
 
@@ -48,9 +56,11 @@ ___
48
56
 
49
57
  • `Optional` **quickFilter**: [`QuickFilter`](QuickFilter.md)
50
58
 
59
+ Filtro rápido
60
+
51
61
  #### Defined in
52
62
 
53
- src/dataunit/loading/LoadDataRequest.ts:7
63
+ src/dataunit/loading/LoadDataRequest.ts:13
54
64
 
55
65
  ___
56
66
 
@@ -58,6 +68,8 @@ ___
58
68
 
59
69
  • `Optional` **sort**: [`Sort`](Sort.md)[]
60
70
 
71
+ Ordenação dos resultados
72
+
61
73
  #### Defined in
62
74
 
63
- src/dataunit/loading/LoadDataRequest.ts:9
75
+ src/dataunit/loading/LoadDataRequest.ts:19
@@ -2,6 +2,8 @@
2
2
 
3
3
  # Interface: LoadDataResponse
4
4
 
5
+ Retorno dos registros da requisição de carregamento de dados
6
+
5
7
  ## Table of contents
6
8
 
7
9
  ### Properties
@@ -15,9 +17,11 @@
15
17
 
16
18
  • `Optional` **paginationInfo**: [`PaginationInfo`](PaginationInfo.md)
17
19
 
20
+ Informações da paginação
21
+
18
22
  #### Defined in
19
23
 
20
- src/dataunit/loading/LoadDataResponse.ts:6
24
+ src/dataunit/loading/LoadDataResponse.ts:10
21
25
 
22
26
  ___
23
27
 
@@ -25,6 +29,8 @@ ___
25
29
 
26
30
  • **records**: [`Record`](Record.md)[]
27
31
 
32
+ Registros retornados na requisição
33
+
28
34
  #### Defined in
29
35
 
30
- src/dataunit/loading/LoadDataResponse.ts:5
36
+ src/dataunit/loading/LoadDataResponse.ts:7
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- src/dataunit/DataUnit.ts:621
21
+ src/dataunit/DataUnit.ts:1131
22
22
 
23
23
  ___
24
24
 
@@ -28,7 +28,7 @@ ___
28
28
 
29
29
  #### Defined in
30
30
 
31
- src/dataunit/DataUnit.ts:622
31
+ src/dataunit/DataUnit.ts:1132
32
32
 
33
33
  ___
34
34
 
@@ -38,4 +38,4 @@ ___
38
38
 
39
39
  #### Defined in
40
40
 
41
- src/dataunit/DataUnit.ts:623
41
+ src/dataunit/DataUnit.ts:1133
@@ -2,6 +2,8 @@
2
2
 
3
3
  # Interface: PaginationInfo
4
4
 
5
+ Informações da paginação retornada na requisição de carregamento de registros
6
+
5
7
  ## Table of contents
6
8
 
7
9
  ### Properties
@@ -18,9 +20,11 @@
18
20
 
19
21
  • **currentPage**: `number`
20
22
 
23
+ Página atual
24
+
21
25
  #### Defined in
22
26
 
23
- src/dataunit/loading/PaginationInfo.ts:3
27
+ src/dataunit/loading/PaginationInfo.ts:5
24
28
 
25
29
  ___
26
30
 
@@ -28,9 +32,11 @@ ___
28
32
 
29
33
  • **firstRecord**: `number`
30
34
 
35
+ Indice do primeiro registro na página
36
+
31
37
  #### Defined in
32
38
 
33
- src/dataunit/loading/PaginationInfo.ts:4
39
+ src/dataunit/loading/PaginationInfo.ts:8
34
40
 
35
41
  ___
36
42
 
@@ -38,9 +44,11 @@ ___
38
44
 
39
45
  • **hasMore**: `boolean`
40
46
 
47
+ Se ainda existem mais registros além dos exibidos na página
48
+
41
49
  #### Defined in
42
50
 
43
- src/dataunit/loading/PaginationInfo.ts:7
51
+ src/dataunit/loading/PaginationInfo.ts:17
44
52
 
45
53
  ___
46
54
 
@@ -48,9 +56,11 @@ ___
48
56
 
49
57
  • **lastRecord**: `number`
50
58
 
59
+ Indice do último registro na página
60
+
51
61
  #### Defined in
52
62
 
53
- src/dataunit/loading/PaginationInfo.ts:5
63
+ src/dataunit/loading/PaginationInfo.ts:11
54
64
 
55
65
  ___
56
66
 
@@ -58,6 +68,8 @@ ___
58
68
 
59
69
  • **total**: `number`
60
70
 
71
+ Quantidade total de registros
72
+
61
73
  #### Defined in
62
74
 
63
- src/dataunit/loading/PaginationInfo.ts:6
75
+ src/dataunit/loading/PaginationInfo.ts:14
@@ -17,7 +17,7 @@
17
17
 
18
18
  #### Defined in
19
19
 
20
- src/dataunit/DataUnit.ts:628
20
+ src/dataunit/DataUnit.ts:1138
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- src/dataunit/DataUnit.ts:627
30
+ src/dataunit/DataUnit.ts:1137
@@ -27,7 +27,7 @@
27
27
 
28
28
  #### Defined in
29
29
 
30
- src/dataunit/DataUnit.ts:560
30
+ src/dataunit/DataUnit.ts:1032
31
31
 
32
32
  ___
33
33
 
@@ -37,4 +37,4 @@ ___
37
37
 
38
38
  #### Defined in
39
39
 
40
- src/dataunit/DataUnit.ts:559
40
+ src/dataunit/DataUnit.ts:1031
@@ -24,7 +24,7 @@
24
24
 
25
25
  #### Defined in
26
26
 
27
- src/dataunit/DataUnit.ts:565
27
+ src/dataunit/DataUnit.ts:1037
28
28
 
29
29
  ___
30
30
 
@@ -38,7 +38,7 @@ ___
38
38
 
39
39
  #### Defined in
40
40
 
41
- src/dataunit/DataUnit.ts:560
41
+ src/dataunit/DataUnit.ts:1032
42
42
 
43
43
  ___
44
44
 
@@ -52,4 +52,4 @@ ___
52
52
 
53
53
  #### Defined in
54
54
 
55
- src/dataunit/DataUnit.ts:559
55
+ src/dataunit/DataUnit.ts:1031
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- src/dataunit/DataUnit.ts:616
21
+ src/dataunit/DataUnit.ts:1126
22
22
 
23
23
  ___
24
24
 
@@ -28,7 +28,7 @@ ___
28
28
 
29
29
  #### Defined in
30
30
 
31
- src/dataunit/DataUnit.ts:617
31
+ src/dataunit/DataUnit.ts:1127
32
32
 
33
33
  ___
34
34
 
@@ -38,4 +38,4 @@ ___
38
38
 
39
39
  #### Defined in
40
40
 
41
- src/dataunit/DataUnit.ts:615
41
+ src/dataunit/DataUnit.ts:1125
@@ -22,7 +22,7 @@
22
22
 
23
23
  src/utils/MaskFormatter.ts:158
24
24
 
25
- src/utils/MaskFormatter.ts:322
25
+ src/utils/MaskFormatter.ts:398
26
26
 
27
27
  ## Variables
28
28
 
@@ -34,4 +34,4 @@ src/utils/MaskFormatter.ts:322
34
34
 
35
35
  src/utils/MaskFormatter.ts:158
36
36
 
37
- src/utils/MaskFormatter.ts:322
37
+ src/utils/MaskFormatter.ts:398
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "2.3.6",
3
+ "version": "2.4.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [