mindee/src/http/responseValidation.d.ts

Mindee Client Library for Node.js

import { EndpointResponse } from "./baseEndpoint";
/**
 * Checks if the synchronous response is valid. Returns True if the response is valid.
 *
 * @param response an endpoint response object.
 * @returns bool
 */
export declare function isValidSyncResponse(response: EndpointResponse): boolean;
/**
 * Checks if the asynchronous response is valid. Also checks if it is a valid synchronous response.
 * Returns True if the response is valid.
 *
 * @param response an endpoint response object.
 * @returns bool
 */
export declare function isValidAsyncResponse(response: EndpointResponse): boolean;
/**
 * Checks and correct the response object depending on the possible kinds of returns.
 *
 * @param response an endpoint response object.
 * @returns EndpointResponse Returns the job error if the error is due to parsing, returns the http error otherwise.
 */
export declare function cleanRequestData(response: EndpointResponse): EndpointResponse;