ketting/dist/http/error.d.ts

Opiniated HATEAOS / Rest client.

/**
 * HttpError extends the Error object, and is thrown wheenever servers emit
 * HTTP errors.
 *
 * It has a response property, allowing users to find out more about the
 * nature of the error.
 */
export declare class HttpError extends Error {
    response: Response;
    status: number;
    constructor(response: Response);
}
/**
 * Problem extends the HttpError object. If a server emits a HTTP error, and
 * the response body's content-type is application/problem+json.
 *
 * application/problem+json is defined in RFC7807 and provides a standardized
 * way to describe error conditions by a HTTP server.
 */
export declare class Problem extends HttpError {
    body: {
        title?: string;
    };
    constructor(response: Response, problemBody: Record<string, any>);
}
/**
 * This function creates problems, not unlike the the author of this file.
 *
 * It takes a Fetch Response object, and returns a HttpError. If the HTTP
 * response has a type of application/problem+json it will return a Problem
 * object.
 *
 * Because parsing the response might be asynchronous, the function returns
 * a Promise resolving in either object.
 */
export default function problemFactory(response: Response): Promise<HttpError | Problem>;