@sankhyalabs/core-docs 4.9.1 → 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/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/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)
|