@elliemae/pui-logrocket 1.0.2 → 1.0.4

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.
@@ -1,6 +1,32 @@
1
1
  import LogRocket from 'logrocket';
2
+ /**
3
+ * LogRocket initialization options
4
+ * @useDeclaredType
5
+ */
2
6
  export type LROptions = Parameters<typeof LogRocket.init>[1] & {
7
+ /**
8
+ * unique identifier of the logrocket project
9
+ * @example 'your-project/your-app'
10
+ * @default window.emui.logRocketConfig.appId
11
+ */
12
+ appId?: string;
13
+ /**
14
+ * indicates if the application is using react framework
15
+ * @default true
16
+ */
3
17
  isReact?: boolean;
4
18
  };
5
- declare const initLogRocket: (id: string, options?: LROptions) => void;
19
+ /**
20
+ * initialize LogRocket
21
+ * @example
22
+ * initLogRocket({
23
+ * appId: 'your-project/your-app',
24
+ * isReact: true, // default is true
25
+ * rootHostname: '.ice.com', // default is .ice.com
26
+ * childDomains: ['.your-domain.com'], // default is null
27
+ * parentDomain: '.your-domain.com', // default is null
28
+ * });
29
+ * @param options {@link LROptions} - LogRocket initialization options
30
+ */
31
+ declare const initLogRocket: (options?: LROptions) => void;
6
32
  export { LogRocket, initLogRocket };