Class UnbluApiError

General unblu JS API error class that will be thrown whenever something goes wrong.

• Use the UnbluApiError.type to check what kind of error occurred.
• Use the UnbluApiError.detail for human readable details.

Check the documentation of UnbluErrorType for more details on the different error types.

Example for the Floating API:

unblu.floating.api.initialize().then(api => {
     // use the api
}).catch(e => {
    if(e.type === 'INITIALIZATION_TIMEOUT') {
         //retry
    } else if(e.type === 'UNSUPPORTED_BROWSER') {
         // display unsupported browser dialog
    } else {
         // show generic error message
    }
})
Copy

or using async / await:

try {
    const api = await unblu.floating.api.initialize()
    // use the api
} catch(e) {
    if(e.type === 'INITIALIZATION_TIMEOUT') {
         //retry
    } else if(e.type === 'UNSUPPORTED_BROWSER') {
         // display unsupported browser dialog
    } else {
         // show generic error message
    }
}
Copy

The error types may either be checked via their constant string values or via the UnbluErrorType enum:

// using string constant
function isTimeout(e: UnbluApiError) {
 return e.type === 'INITIALIZATION_TIMEOUT'
}
Copy

// using the enum
function isTimeout(e: UnbluApiError) {
 return e.type === window.unblu.UnbluErrorType.INITIALIZATION_TIMEOUT
}
Copy