turbocommons-ts/managers/httpmanager/HTTPManagerBaseRequest.d.ts

General purpose library that implements frequently used and generic software development tasks

/**
 * TurboCommons is a general purpose and cross-language library that implements frequently used and generic software development tasks.
 *
 * Website : -> https://turboframework.org/en/libs/turbocommons
 * License : -> Licensed under the Apache License, Version 2.0. You may not use this file except in compliance with the License.
 * License Url : -> http://www.apache.org/licenses/LICENSE-2.0
 * CopyRight : -> Copyright 2015 Edertone Advanded Solutions (08211 Castellar del Vallès, Barcelona). http://www.edertone.com
 */
/**
 * Class that defines the base http request to be used with http manager
 */
export declare abstract class HTTPManagerBaseRequest {
    /**
     * Defines the string format for the result format property.
     * The result of request with this resultFormat will be returned as a raw string containing the exact request response body.
     */
    static readonly STRING = "STRING";
    /**
     * Defines the json format for the result format property.
     * The result of request with this resultFormat will be a native type which will have been decoded from the request response
     * body (expecting it to be a valid json string).
     */
    static readonly JSON = "JSON";
    /**
     * Specifies how the result of the request will be transformed. Possible values are:
     * - HTTPManagerBaseRequest.STRING (See the constant docs for more info)
     * - HTTPManagerBaseRequest.JSON (See the constant docs for more info)
     */
    resultFormat: typeof HTTPManagerBaseRequest.STRING | typeof HTTPManagerBaseRequest.JSON;
    /**
     * The url that will be called as part of this request
     */
    url: string;
    /**
     * Defines how much miliseconds will the http requests wait before failing with a timeout.
     * If set to 0, no value will be specifically defined, so the httpmanager default will be used.
     */
    timeout: number;
    /**
     * If set to true, any global POST parameters that may be defined by the http manager which executes this request will be ignored.
     * (exclusively for this request only)
     */
    ignoreGlobalPostParams: boolean;
    constructor(url: string, resultFormat?: typeof HTTPManagerBaseRequest.STRING | typeof HTTPManagerBaseRequest.JSON, timeout?: number);
    /**
     * A method to be executed inmediately after the request execution finishes successfully (200 ok code).
     * The callback function must have the following signature:
     * (response) => void
     * Where the response will be formatted according to how resultFormat is defined
     */
    successCallback: (response: any) => void;
    /**
     * A method to be executed if an error happens to the request execution.
     * The callback function must have the following signature:
     * (errorMsg:string, errorCode:number, response: string) => void
     *
     * errorMsg will contain the error text, errorCode will contain the numeric error http value and response will contain
     * the main request response body
     */
    errorCallback: (errorMsg: string, errorCode: number, response: string) => void;
    /**
     * A method to be executed always when the request finishes, even successfully or with an error.
     * (This will be the very last method to be executed, allways after success or error callbacks).
     *
     * The callback function must have the following signature:
     * () => void
     */
    finallyCallback: () => void;
}