@appxiom/web 0.1.11 → 0.1.12
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/README.md +35 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,6 +6,7 @@ The official client-side JavaScript SDK for Appxiom. Use this package to initial
|
|
|
6
6
|
|
|
7
7
|
- [Before You Begin](#before-you-begin)
|
|
8
8
|
- [Installation](#installation)
|
|
9
|
+
- [Test Integration](#test-integration)
|
|
9
10
|
- [Quick Start](#quick-start)
|
|
10
11
|
- [Vite](#vite)
|
|
11
12
|
- [Frameworks and SSR](#frameworks-and-ssr)
|
|
@@ -28,6 +29,40 @@ The official client-side JavaScript SDK for Appxiom. Use this package to initial
|
|
|
28
29
|
npm install @appxiom/web
|
|
29
30
|
```
|
|
30
31
|
|
|
32
|
+
## Test Integration
|
|
33
|
+
|
|
34
|
+
After installation, validate that your SDK is connected properly by triggering a temporary test issue from the initialized client. Call the helper method `#sym:raiseTestIssue` once in a safe debug path or temporary validation flow:
|
|
35
|
+
|
|
36
|
+
### JavaScript
|
|
37
|
+
|
|
38
|
+
```javascript
|
|
39
|
+
const ax = await init(
|
|
40
|
+
'YOUR_APP_KEY',
|
|
41
|
+
'YOUR_PLATFORM_KEY',
|
|
42
|
+
'YOUR_APP_VERSION',
|
|
43
|
+
'YOUR_BUILD_IDENTIFIER',
|
|
44
|
+
);
|
|
45
|
+
|
|
46
|
+
ax.raiseTestIssue();
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### TypeScript
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import init, { type AX } from '@appxiom/web';
|
|
53
|
+
|
|
54
|
+
const ax: AX = await init(
|
|
55
|
+
'YOUR_APP_KEY',
|
|
56
|
+
'YOUR_PLATFORM_KEY',
|
|
57
|
+
'YOUR_APP_VERSION',
|
|
58
|
+
'YOUR_BUILD_IDENTIFIER',
|
|
59
|
+
);
|
|
60
|
+
|
|
61
|
+
ax.raiseTestIssue();
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
This creates a custom issue with a payload and stack trace so you can confirm the issue is being reported in the Appxiom dashboard. After successful validation, remove the call and any temporary debug trigger so the test issue is not left in production code.
|
|
65
|
+
|
|
31
66
|
## Quick Start
|
|
32
67
|
|
|
33
68
|
### JavaScript
|