Interface InitializationOptions

interface InitializationOptions {
    allowThreads?: boolean;
    engine?: string;
    licenseKey: string;
    requestSuffix?: string;
    verboseLogging?: boolean;
}

Properties

allowThreads? engine? licenseKey requestSuffix? verboseLogging?

Properties

Optional allowThreads

allowThreads?: boolean

Determines whether the SDK should use multithreading. Defaults to true. Multithreading will only affect supported Android devices and desktop browsers. Multithreading on iOS is currently not supported. On supported devices, multithreading will improve performance significantly. Note that multithreading will only work on crossOriginIsolated sites. To enable this for your site, certain HTTP headers need to be set. Please consult our documentation for more information. If multithreading was requested but the site is not in a crossOriginIsolated context, the SDK will print a warning and fallback to single-threaded operation.

Optional engine

engine?: string

Location of the Core WebAssembly Engine. Mandatory.

Deprecated

This option is deprecated and will be replaced by the option enginePath in the next major release.

licenseKey

licenseKey: string

Scanbot Web SDK License key. Required

Optional requestSuffix

requestSuffix?: string

The requestSuffix is appended to the HTTP requests made by the SDK to load necessary WASM and JS files. It is meant to avoid any caching issues that may arise when the SDK is updated. Defaults to '?CURRENT_SDK_VERSION'.

Optional verboseLogging

verboseLogging?: boolean

Determines whether the SDK should log debug messages. Defaults to false.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc