@splitsoftware/browser-suite - npm Package Compare versions

Comparing version 2.0.0-rc.0 to 2.0.0-rc.1

cjs/browserSuite.js

@@ -15,4 +15,4 @@ "use strict";
  *
- * @param config configuration object used to instantiate the Suite
- * @param __updateModules optional function that lets redefine internal SDK modules. Use with
+ * @param config - configuration object used to instantiate the Suite
+ * @param __updateModules - optional function that lets redefine internal SDK modules. Use with
  * caution since, unlike `config`, this param is not validated neither considered part of the public API.
@@ -19,0 +19,0 @@ * @throws Will throw an error if the provided config is invalid.

esm/browserSuite.js

@@ -12,4 +12,4 @@ import { objectAssign } from '@splitsoftware/splitio-commons/esm/utils/lang/objectAssign';
  *
- * @param config configuration object used to instantiate the Suite
- * @param __updateModules optional function that lets redefine internal SDK modules. Use with
+ * @param config - configuration object used to instantiate the Suite
+ * @param __updateModules - optional function that lets redefine internal SDK modules. Use with
  * caution since, unlike `config`, this param is not validated neither considered part of the public API.
@@ -16,0 +16,0 @@ * @throws Will throw an error if the provided config is invalid.

package.json

 {
   "name": "@splitsoftware/browser-suite",
-  "version": "2.0.0-rc.0",
+  "version": "2.0.0-rc.1",
   "description": "Split Suite for JavaScript on Browser",
@@ -52,3 +52,3 @@ "main": "cjs/index.js",
     "@splitsoftware/browser-rum-agent": "0.7.1",
-    "@splitsoftware/splitio-browserjs": "1.0.0-rc.1",
+    "@splitsoftware/splitio-browserjs": "1.0.0-rc.3",
     "tslib": "^2.3.1"
@@ -68,2 +68,3 @@ },
     "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-tsdoc": "^0.3.0",
     "fetch-mock": "^9.11.0",
@@ -70,0 +71,0 @@ "husky": "^8.0.3",

src/browserSuite.ts

@@ -17,4 +17,4 @@ import { objectAssign } from '@splitsoftware/splitio-commons/src/utils/lang/objectAssign';
  *
- * @param config configuration object used to instantiate the Suite
- * @param __updateModules optional function that lets redefine internal SDK modules. Use with
+ * @param config - configuration object used to instantiate the Suite
+ * @param __updateModules - optional function that lets redefine internal SDK modules. Use with
  * caution since, unlike `config`, this param is not validated neither considered part of the public API.
@@ -21,0 +21,0 @@ * @throws Will throw an error if the provided config is invalid.

types/index.d.ts

@@ -25,4 +25,3 @@ // Declaration file for JavaScript Browser Split Software SDK
  * Settings interface for Suite instances created on the browser.
- * @interface IBrowserSuiteSettings
- * @extends IBrowserSettings
+ *
  * @see {@link https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK#configuration}
@@ -36,4 +35,2 @@ */
      * This does not affect the behavior of the SDK client: even if provided, you still need to specify the traffic type in `client.track()` calls.
-     *
-     * @property {string=} trafficType
      */
@@ -53,3 +50,4 @@ trafficType?: string,
        * Whether to register `error` events or not.
-       * @default true
+       *
+       * @defaultValue `true`
        */
@@ -59,3 +57,4 @@ errors?: boolean,
        * Whether to register navigation timing events, i.e., `page.load.time` and `time.to.dom.interactive` events.
-       * @default true
+       *
+       * @defaultValue `true`
        */
@@ -65,3 +64,4 @@ navigationTiming?: boolean,
        * Whether to register Web-Vitals events or not. If an object is provided, it will be used as the configuration for the Web-Vitals event collector.
-       * @default true
+       *
+       * @defaultValue `true`
        * @see {@link https://help.split.io/hc/en-us/articles/360030898431-Browser-RUM-Agent#web-vitals}
@@ -76,4 +76,2 @@ */
  * This represents the interface for the Suite instance, that is an extension of the ISDK interface.
- * @interface ISuiteSDK
- * @extends ISDK
  */
@@ -86,4 +84,3 @@ export interface ISuiteSDK extends SplitIO.ISDK {
    *
-   * @function client
-   * @returns {IClient} The client instance.
+   * @returns The client instance.
    */
@@ -96,6 +93,5 @@ client(): SplitIO.IClient,
    *
-   * @function client
-   * @param {SplitKey} key The key for the new client instance.
-   * @param {string=} trafficType The traffic type of the provided key, used to pass an identity to the RUM agent. If not provided, 'user' will be used as default.
-   * @returns {IClient} The client instance.
+   * @param key - The key for the new client instance.
+   * @param trafficType - The traffic type of the provided key, used to pass an identity to the RUM agent. If not provided, 'user' will be used as default.
+   * @returns The client instance.
    */
@@ -106,4 +102,3 @@ client(key: SplitIO.SplitKey, trafficType?: string): SplitIO.IClient,
    *
-   * @function rumAgent
-   * @returns {typeof SplitRumAgent} The RUM Agent instance.
+   * @returns The RUM Agent instance.
    */
@@ -115,4 +110,3 @@ rumAgent(): typeof SplitRumAgent
    *
-   * @function destroy
-   * @returns {Promise<void>} A promise that resolves once the client is destroyed.
+   * @returns A promise that resolves once the client is destroyed.
    */
@@ -119,0 +113,0 @@ destroy(): Promise<void>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

37475

decreased by-0.58%

Dev dependency count

31

increased by3.33%

Lines of code

516

decreased by-1.15%

Dependency changes

• + Added@splitsoftware/splitio-browserjs@1.0.0-rc.3(transitive)

• + Added@splitsoftware/splitio-commons@2.0.0-rc.6(transitive)

• + Addedunfetch@4.2.0(transitive)

• - Removed@splitsoftware/splitio-browserjs@1.0.0-rc.1(transitive)

• - Removed@splitsoftware/splitio-commons@2.0.0-rc.4(transitive)

• Updated@splitsoftware/splitio-browserjs@1.0.0-rc.3