Skip to content

Add a deprecation warning environment, restHost and realtimeHost client options #2049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VeskeR merged 1 commit into from
Jun 25, 2025
Merged

Add a deprecation warning environment, restHost and realtimeHost client options #2049

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions src/common/lib/util/defaults.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,10 +274,21 @@ export function normaliseOptions(
MsgPack: MsgPack | null,
logger: Logger | null, // should only be omitted by tests
): NormalisedClientOptions {
checkIfClientOptionsAreValid(options);

const loggerToUse = logger ?? Logger.defaultLogger;

// Deprecated options
if (options.environment) {
loggerToUse.deprecated('The `environment` client option', 'Use the `endpoint` client option instead.');
}
if (options.restHost) {
loggerToUse.deprecated('The `restHost` client option', 'Use the `endpoint` client option instead.');
}
if (options.realtimeHost) {
loggerToUse.deprecated('The `realtimeHost` client option', 'Use the `endpoint` client option instead.');
}

checkIfClientOptionsAreValid(options);

if (typeof options.recover === 'function' && options.closeOnUnload === true) {
Logger.logAction(
loggerToUse,
Expand Down
Loading