@finos/legend-shared/lib/error/ErrorUtils.d.ts

Legend Studio shared utilities and helpers

/**
 * Copyright (c) 2020-present, Goldman Sachs
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { type SuperGenericFunction } from '../CommonUtils.js';
/**
 * A generic error that can be used for building other errors in the application
 * which does not require Javascript stack trace.
 *
 * If the Javascript stack trace is needed to trace back where the problem occurs,
 * `EnrichedError` is the more suitable candidate.
 *
 * This type of error is useful for wrapping the innermost error or errors coming
 * from the servers. Since we enforce in the app that errors thrown must be of type
 * `Error`, this acts as a good wrapper to manage errors better.
 * See https://github.com/microsoft/TypeScript/issues/13219
 */
export declare abstract class ApplicationError extends Error {
    readonly uuid: string;
    constructor(message: string | undefined);
    /**
     * This provides more detail (better context) about the error, including the error message
     * stack trace, etc.
     */
    get detail(): string;
}
export declare class EnrichedError extends Error {
    constructor(name: string, error: string | Error | undefined, overideMessage?: string);
}
/**
 * Signals that a method has been invoked at an illegal or
 * inappropriate point at runtime. In other words, the environment
 * or application is not in an appropriate state for the requested
 * operation.
 */
export declare class IllegalStateError extends EnrichedError {
    constructor(error?: Error | string);
}
export declare class UnsupportedOperationError extends EnrichedError {
    constructor(message?: string | undefined, unsupportedObject?: unknown);
}
/**
 * This is a relatively crude way to handle error of type unknown thrown for now.
 * We should revisit this when Typescript supports `throws` clause
 * See https://github.com/microsoft/TypeScript/issues/13219
 *
 * NOTE: There's a problem with this check in JSDOM leading so we have to disable this in test environment
 * JSDOM uses their own isolated object rather than native object for performance purpose
 * See https://github.com/jsdom/jsdom/issues/3082
 * For example, TypeErrors generated by `webidl2js` or `whatwg-url` used by `jsdom`, or manually-thrown ones inside impl classes,
 * are thrown using global.TypeError, not dom.window.TypeError. This change is hard to implement as of now
 * See https://github.com/jsdom/jsdom/issues/2727
 * See https://github.com/facebook/jest/issues/2549
 *
 * Read more related discussions at:
 * https://github.com/jsdom/jsdom/issues/1737
 * https://github.com/webcomponents/polyfills/issues/105
 * https://github.com/jsdom/jsdom/issues/1769
 * https://github.com/jsdom/jsdom/issues/2555
 */
export declare function assertErrorThrown(error: unknown): asserts error is Error;
export declare const returnUndefOnError: <T extends SuperGenericFunction>(fn: T) => ReturnType<T> | undefined;
export declare const decorateErrorMessageIfExists: <T extends SuperGenericFunction>(fn: T, errorMessageDecorator: (msg: string) => string) => ReturnType<T>;
//# sourceMappingURL=ErrorUtils.d.ts.map