Skip to content

Commit c0a2c20

Browse files
committed
docs: removed a TODO and enhanced documentation for IterableLogger
1 parent a4bd708 commit c0a2c20

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

src/core/classes/IterableLogger.ts

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ const DEFAULT_LOGGING_ENABLED = true;
66
/**
77
* A logger class for the Iterable SDK.
88
*
9-
* This class is responsible for logging messages based on the configuration provided.
10-
*
11-
* TODO: add a logLevel property to the IterableLogger class to control the level of logging.
9+
* This class is responsible for logging messages based on the configuration
10+
* provided, is useful in unit testing or debug environments.
1211
*
1312
* @remarks
1413
* The logging behavior is controlled by the `logReactNativeSdkCalls` property
1514
* in {@link IterableConfig}.
16-
* If this property is not set, logging defaults to `true`, which is useful in unit testing or debug environments.
15+
*
16+
* If this property is not set, logging defaults to `true`, which is useful in
17+
* unit testing or debug environments.
1718
*
1819
* @example
1920
* ```typescript
@@ -99,7 +100,8 @@ export class IterableLogger {
99100
}
100101

101102
/**
102-
* Logs a message to the console if the log level is {@link IterableLogLevel.debug} or lower.
103+
* Logs a message to the console if the log level is
104+
* {@link IterableLogLevel.debug} or {@link IterableLogLevel.error}.
103105
*
104106
* @param message - The message to be logged.
105107
*
@@ -122,7 +124,9 @@ export class IterableLogger {
122124
}
123125

124126
/**
125-
* Logs a message to the console if the log level is {@link IterableLogLevel.info} or lower.
127+
* Logs a message to the console if the log level is
128+
* {@link IterableLogLevel.info}, {@link IterableLogLevel.debug} or
129+
* {@link IterableLogLevel.error}.
126130
*
127131
* @param message - The message to be logged.
128132
*

0 commit comments

Comments
 (0)