@openfin/bloomberg
Version:
Connect apps running in OpenFin with the Bloomberg Terminal.
61 lines (60 loc) • 1.48 kB
TypeScript
/**
* Base class for custom errors throw by the API.
*
* @group Errors
*/
export declare class ApiError extends Error {
data?: unknown;
constructor(message?: string, data?: unknown);
}
/**
* Thrown when an unexpected error occurs in the background adapter process.
*
* @group Errors
*/
export declare class AdapterError extends ApiError {
constructor(message?: string, data?: unknown);
}
/**
* Thrown when initialization of the background adapter process fails.
*
* @group Errors
*/
export declare class InitializationError extends ApiError {
constructor(message?: string, data?: unknown);
}
/**
* Thrown when an interop operation results in an error.
*
* @group Errors
*/
export declare class InteropError extends ApiError {
constructor(message?: string, data?: unknown);
}
/**
* Thrown when invalid parameter values are provided to API functions.
*
* @group Errors
*/
export declare class ParameterError extends ApiError {
/**
* @param message Description of the error.
*/
constructor(message?: string);
}
/**
* Thrown when unable to establish a connection to the Terminal.
*
* @group Errors
*/
export declare class TerminalConnectionError extends ApiError {
constructor(message?: string, data?: unknown);
}
/**
* Thrown when a Terminal Connect API request fails.
*
* @group Errors
*/
export declare class TerminalConnectRequestError extends ApiError {
constructor(message?: string, data?: unknown);
}