From 424edc5539a3e8ef3de58eacc3b59b8c37a0ace3 Mon Sep 17 00:00:00 2001 From: Emiliano Sanchez Date: Thu, 17 Aug 2023 10:59:12 -0300 Subject: [PATCH] update type definitions comments for 'debug' configuration parameter --- types/splitio.d.ts | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/types/splitio.d.ts b/types/splitio.d.ts index 6794375d..38f9c2ed 100644 --- 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,