@superset-ui/core/lib/query/getClientErrorObject.d.ts

Superset UI core

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 { JsonObject, SupersetClientResponse, SupersetError } from '@superset-ui/core';
export type ClientErrorObject = {
    error: string;
    errors?: SupersetError[];
    link?: string;
    message?: string;
    severity?: string;
    stacktrace?: string;
    statusText?: string;
} & Partial<SupersetClientResponse>;
interface TimeoutError {
    statusText: 'timeout';
    timeout: number;
}
type ErrorType = SupersetClientResponse | TimeoutError | {
    response: Response;
} | string;
type ErrorTextSource = 'dashboard' | 'chart' | 'query' | 'dataset' | 'database';
export declare function checkForHtml(str: string): boolean;
export declare function parseStringResponse(str: string): string;
export declare function getErrorFromStatusCode(status: number): string | null;
export declare function retrieveErrorMessage(str: string, errorObject: JsonObject): string;
export declare function parseErrorJson(responseJson: JsonObject): ClientErrorObject;
export declare function getClientErrorObject(response: SupersetClientResponse | TimeoutError | {
    response: Response;
} | string): Promise<ClientErrorObject>;
export declare function getErrorText(errorObject: ErrorType, source: ErrorTextSource): Promise<string>;
export declare function getClientErrorMessage(message: string, clientError?: ClientErrorObject): string;
export {};
//# sourceMappingURL=getClientErrorObject.d.ts.map