@sankhyalabs/core-docs 4.9.0 → 4.10.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/OnboardingUtils.md +126 -0
- package/classes/StringUtils.md +16 -16
- package/modules.md +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / OnboardingUtils
|
|
2
|
+
|
|
3
|
+
# Class: OnboardingUtils
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Constructors
|
|
8
|
+
|
|
9
|
+
- [constructor](OnboardingUtils.md#constructor)
|
|
10
|
+
|
|
11
|
+
### Properties
|
|
12
|
+
|
|
13
|
+
- [USER\_GUIDE\_TAG\_ID](OnboardingUtils.md#user_guide_tag_id)
|
|
14
|
+
- [instance](OnboardingUtils.md#instance)
|
|
15
|
+
|
|
16
|
+
### Methods
|
|
17
|
+
|
|
18
|
+
- [init](OnboardingUtils.md#init)
|
|
19
|
+
- [injectScript](OnboardingUtils.md#injectscript)
|
|
20
|
+
- [register](OnboardingUtils.md#register)
|
|
21
|
+
- [getInstance](OnboardingUtils.md#getinstance)
|
|
22
|
+
|
|
23
|
+
## Constructors
|
|
24
|
+
|
|
25
|
+
### constructor
|
|
26
|
+
|
|
27
|
+
• `Private` **new OnboardingUtils**()
|
|
28
|
+
|
|
29
|
+
#### Defined in
|
|
30
|
+
|
|
31
|
+
src/utils/OnboardingUtils.ts:5
|
|
32
|
+
|
|
33
|
+
## Properties
|
|
34
|
+
|
|
35
|
+
### USER\_GUIDE\_TAG\_ID
|
|
36
|
+
|
|
37
|
+
▪ `Static` `Private` `Readonly` **USER\_GUIDE\_TAG\_ID**: ``"userGuideSnippet"``
|
|
38
|
+
|
|
39
|
+
#### Defined in
|
|
40
|
+
|
|
41
|
+
src/utils/OnboardingUtils.ts:2
|
|
42
|
+
|
|
43
|
+
___
|
|
44
|
+
|
|
45
|
+
### instance
|
|
46
|
+
|
|
47
|
+
▪ `Static` `Private` **instance**: [`OnboardingUtils`](OnboardingUtils.md)
|
|
48
|
+
|
|
49
|
+
#### Defined in
|
|
50
|
+
|
|
51
|
+
src/utils/OnboardingUtils.ts:3
|
|
52
|
+
|
|
53
|
+
## Methods
|
|
54
|
+
|
|
55
|
+
### init
|
|
56
|
+
|
|
57
|
+
▸ **init**(`apiKey`, `ctx`): `Promise`<`void`\>
|
|
58
|
+
|
|
59
|
+
#### Parameters
|
|
60
|
+
|
|
61
|
+
| Name | Type |
|
|
62
|
+
| :------ | :------ |
|
|
63
|
+
| `apiKey` | `string` |
|
|
64
|
+
| `ctx` | `EnvironmentContext` |
|
|
65
|
+
|
|
66
|
+
#### Returns
|
|
67
|
+
|
|
68
|
+
`Promise`<`void`\>
|
|
69
|
+
|
|
70
|
+
#### Defined in
|
|
71
|
+
|
|
72
|
+
src/utils/OnboardingUtils.ts:14
|
|
73
|
+
|
|
74
|
+
___
|
|
75
|
+
|
|
76
|
+
### injectScript
|
|
77
|
+
|
|
78
|
+
▸ `Private` **injectScript**(`apiKey`): `void`
|
|
79
|
+
|
|
80
|
+
#### Parameters
|
|
81
|
+
|
|
82
|
+
| Name | Type |
|
|
83
|
+
| :------ | :------ |
|
|
84
|
+
| `apiKey` | `string` |
|
|
85
|
+
|
|
86
|
+
#### Returns
|
|
87
|
+
|
|
88
|
+
`void`
|
|
89
|
+
|
|
90
|
+
#### Defined in
|
|
91
|
+
|
|
92
|
+
src/utils/OnboardingUtils.ts:23
|
|
93
|
+
|
|
94
|
+
___
|
|
95
|
+
|
|
96
|
+
### register
|
|
97
|
+
|
|
98
|
+
▸ `Private` **register**(`ctx`): `void`
|
|
99
|
+
|
|
100
|
+
#### Parameters
|
|
101
|
+
|
|
102
|
+
| Name | Type |
|
|
103
|
+
| :------ | :------ |
|
|
104
|
+
| `ctx` | `EnvironmentContext` |
|
|
105
|
+
|
|
106
|
+
#### Returns
|
|
107
|
+
|
|
108
|
+
`void`
|
|
109
|
+
|
|
110
|
+
#### Defined in
|
|
111
|
+
|
|
112
|
+
src/utils/OnboardingUtils.ts:34
|
|
113
|
+
|
|
114
|
+
___
|
|
115
|
+
|
|
116
|
+
### getInstance
|
|
117
|
+
|
|
118
|
+
▸ `Static` **getInstance**(): [`OnboardingUtils`](OnboardingUtils.md)
|
|
119
|
+
|
|
120
|
+
#### Returns
|
|
121
|
+
|
|
122
|
+
[`OnboardingUtils`](OnboardingUtils.md)
|
|
123
|
+
|
|
124
|
+
#### Defined in
|
|
125
|
+
|
|
126
|
+
src/utils/OnboardingUtils.ts:7
|
package/classes/StringUtils.md
CHANGED
|
@@ -61,7 +61,7 @@ Determina a ordem de strings.
|
|
|
61
61
|
|
|
62
62
|
#### Defined in
|
|
63
63
|
|
|
64
|
-
src/utils/StringUtils.ts:
|
|
64
|
+
src/utils/StringUtils.ts:223
|
|
65
65
|
|
|
66
66
|
___
|
|
67
67
|
|
|
@@ -114,7 +114,7 @@ string formatada de acordo com a unidade.
|
|
|
114
114
|
|
|
115
115
|
#### Defined in
|
|
116
116
|
|
|
117
|
-
src/utils/StringUtils.ts:
|
|
117
|
+
src/utils/StringUtils.ts:308
|
|
118
118
|
|
|
119
119
|
___
|
|
120
120
|
|
|
@@ -132,7 +132,7 @@ id único randômico.
|
|
|
132
132
|
|
|
133
133
|
#### Defined in
|
|
134
134
|
|
|
135
|
-
src/utils/StringUtils.ts:
|
|
135
|
+
src/utils/StringUtils.ts:355
|
|
136
136
|
|
|
137
137
|
___
|
|
138
138
|
|
|
@@ -164,7 +164,7 @@ Informado: 'false' | Retorna: false
|
|
|
164
164
|
|
|
165
165
|
#### Defined in
|
|
166
166
|
|
|
167
|
-
src/utils/StringUtils.ts:
|
|
167
|
+
src/utils/StringUtils.ts:153
|
|
168
168
|
|
|
169
169
|
___
|
|
170
170
|
|
|
@@ -194,7 +194,7 @@ Informado: '123456' | Retorna: 1450575459
|
|
|
194
194
|
|
|
195
195
|
#### Defined in
|
|
196
196
|
|
|
197
|
-
src/utils/StringUtils.ts:
|
|
197
|
+
src/utils/StringUtils.ts:132
|
|
198
198
|
|
|
199
199
|
___
|
|
200
200
|
|
|
@@ -258,7 +258,7 @@ Ou retorna o texto com os caracteres adicionados na direita.
|
|
|
258
258
|
|
|
259
259
|
#### Defined in
|
|
260
260
|
|
|
261
|
-
src/utils/StringUtils.ts:
|
|
261
|
+
src/utils/StringUtils.ts:207
|
|
262
262
|
|
|
263
263
|
___
|
|
264
264
|
|
|
@@ -297,7 +297,7 @@ Ou retorna o texto com os caracteres adicionados na esquerda.
|
|
|
297
297
|
|
|
298
298
|
#### Defined in
|
|
299
299
|
|
|
300
|
-
src/utils/StringUtils.ts:
|
|
300
|
+
src/utils/StringUtils.ts:182
|
|
301
301
|
|
|
302
302
|
___
|
|
303
303
|
|
|
@@ -322,7 +322,7 @@ simplificação do strNumber, sem os zeros à direita depois do ponto.
|
|
|
322
322
|
|
|
323
323
|
#### Defined in
|
|
324
324
|
|
|
325
|
-
src/utils/StringUtils.ts:
|
|
325
|
+
src/utils/StringUtils.ts:334
|
|
326
326
|
|
|
327
327
|
___
|
|
328
328
|
|
|
@@ -352,7 +352,7 @@ entrada: "á@Êç#Ò", true // retorno: "aEcO"
|
|
|
352
352
|
|
|
353
353
|
#### Defined in
|
|
354
354
|
|
|
355
|
-
src/utils/StringUtils.ts:
|
|
355
|
+
src/utils/StringUtils.ts:105
|
|
356
356
|
|
|
357
357
|
___
|
|
358
358
|
|
|
@@ -376,7 +376,7 @@ Remove acentos de vogais, substitui Ç por c e retorna a string em caixa alta ma
|
|
|
376
376
|
|
|
377
377
|
#### Defined in
|
|
378
378
|
|
|
379
|
-
src/utils/StringUtils.ts:
|
|
379
|
+
src/utils/StringUtils.ts:121
|
|
380
380
|
|
|
381
381
|
___
|
|
382
382
|
|
|
@@ -404,7 +404,7 @@ entrada: "áêçò" // retorno: "aeco"
|
|
|
404
404
|
|
|
405
405
|
#### Defined in
|
|
406
406
|
|
|
407
|
-
src/utils/StringUtils.ts:
|
|
407
|
+
src/utils/StringUtils.ts:85
|
|
408
408
|
|
|
409
409
|
___
|
|
410
410
|
|
|
@@ -456,7 +456,7 @@ String sem espaços em branco.
|
|
|
456
456
|
|
|
457
457
|
#### Defined in
|
|
458
458
|
|
|
459
|
-
src/utils/StringUtils.ts:
|
|
459
|
+
src/utils/StringUtils.ts:298
|
|
460
460
|
|
|
461
461
|
___
|
|
462
462
|
|
|
@@ -487,7 +487,7 @@ String convertida em camelCase.
|
|
|
487
487
|
|
|
488
488
|
#### Defined in
|
|
489
489
|
|
|
490
|
-
src/utils/StringUtils.ts:
|
|
490
|
+
src/utils/StringUtils.ts:249
|
|
491
491
|
|
|
492
492
|
___
|
|
493
493
|
|
|
@@ -511,7 +511,7 @@ String convertida em KebabCase.
|
|
|
511
511
|
|
|
512
512
|
#### Defined in
|
|
513
513
|
|
|
514
|
-
src/utils/StringUtils.ts:
|
|
514
|
+
src/utils/StringUtils.ts:289
|
|
515
515
|
|
|
516
516
|
___
|
|
517
517
|
|
|
@@ -535,7 +535,7 @@ String convertida em PascalCase.
|
|
|
535
535
|
|
|
536
536
|
#### Defined in
|
|
537
537
|
|
|
538
|
-
src/utils/StringUtils.ts:
|
|
538
|
+
src/utils/StringUtils.ts:264
|
|
539
539
|
|
|
540
540
|
___
|
|
541
541
|
|
|
@@ -559,4 +559,4 @@ String convertida em snake_case.
|
|
|
559
559
|
|
|
560
560
|
#### Defined in
|
|
561
561
|
|
|
562
|
-
src/utils/StringUtils.ts:
|
|
562
|
+
src/utils/StringUtils.ts:276
|
package/modules.md
CHANGED
|
@@ -37,6 +37,7 @@
|
|
|
37
37
|
- [MaskFormatter](classes/MaskFormatter-1.md)
|
|
38
38
|
- [NumberUtils](classes/NumberUtils.md)
|
|
39
39
|
- [ObjectUtils](classes/ObjectUtils.md)
|
|
40
|
+
- [OnboardingUtils](classes/OnboardingUtils.md)
|
|
40
41
|
- [ReadyUtil](classes/ReadyUtil.md)
|
|
41
42
|
- [RequestMetadata](classes/RequestMetadata.md)
|
|
42
43
|
- [SelectionInfo](classes/SelectionInfo.md)
|