InitOptions Type

InitOptions type represents the configuration options for initializing the SDK

Web SDK v3.X.X+: Pass a SukiAuthManager instance from @suki-sdk/core using the authManager field on initialize or init instead of supplying partner fields only on those calls.

Refer to Migrating to Web SDK v3 for more details.

InitOptions type represents the configuration options for initializing the SDK. The code snippet below shows how to use the InitOptions type to create an init options object.

JavaScript

type InitOptions = PartnerDetails & {
  enableDebug?: boolean;
  logLevel?: LogLevel;
  isTestMode?: boolean;
  theme?: ThemeOptions;
};

Properties

The following properties are available on the InitOptions type:

Hide properties

enableDebug · boolean · default: "false"

Whether to enable debug mode. This will log additional information to the console.

logLevel · LogLevel

The log level to use when debug mode is enabled. Controls which messages are output to the console.

isTestMode · boolean · default: "false"

Whether to connect to stage environment. This will use stage endpoints. From Web SDK v3.0.0+: do not use this field to choose staging vs production; use environment on SukiAuthManager instead. Refer to Migrating to Web SDK v3 for more details.

theme · ThemeOptions

The theme configuration for the SDK.

Extends: PartnerDetails

Pass encounter on initialize or init for Patient Summary, including practitionerFhirId. The SDK accepts encounter at initialize even if InitOptions does not list it. Generation needs practitionerFhirId at login. Refer to Patient Summary in Web SDK for more information.