Merge pull request #758 from splitio/type_definitions_update

Update type definitions comments for 'debug' configuration parameter
splitio · Aug 23, 2023 · 321f617 · 321f617
2 parents 3e9f3cc + 95586d1
commit 321f617
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/types/splitio.d.ts b/types/splitio.d.ts
@@ -189,8 +189,14 @@ interface IUserConsentAPI {
  */
 interface ISharedSettings {
   /**
-   * Whether the logger should be enabled or disabled by default.
-   * @property {Boolean} debug
+   * Boolean value to indicate whether the logger should be enabled or disabled, or a log level string.
+   *
+   * Examples:
+   * ```javascript
+   * config.debug = true
+   * config.debug = 'WARN'
+   * ```
+   * @property {boolean | LogLevel} debug
    * @default false
    */
   debug?: boolean | LogLevel,