Skip to content

Commit 27f6c04

Browse files
committed
fix: review update
1 parent b93d796 commit 27f6c04

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

src/options.context.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ const getPublicSessionHash = (sessionId: string): string =>
3737
/**
3838
* Initialize and return session data.
3939
*
40+
* @note Potential breaking change with the move to using `mode` in channel names.
41+
* However, the session ID shifts, so we're unclear why someone would be using
42+
* the whole channel name, plus there's a provided callback associated with
43+
* logging. We'll note the update in release notes.
44+
*
4045
* @returns {AppSession} Immutable session with a session ID and channel name.
4146
*/
4247
const initializeSession = (): AppSession => {
@@ -182,6 +187,11 @@ const getLoggerOptions = (session = getSessionOptions()): LoggingSession => {
182187
/**
183188
* Get stat channel options from the current context.
184189
*
190+
* @note Potential breaking change with the move to using `mode` in channel names.
191+
* However, the session ID shifts, so we're unclear why someone would be using
192+
* the whole channel name, plus there's a provided callback associated with
193+
* stats. We'll note the update in release notes.
194+
*
185195
* @param {AppSession} [options] - Session options to use in context.
186196
* @returns {StatsSession} Stats options from context.
187197
*/

0 commit comments

Comments
 (0)