@rxx/http/lib/development/types.d.ts

Http IO module for rxx.

/**
 * @fileoverview
 * @author Taketoshi Aono
 */
import { StateHandlerData } from '@rxx/core';
/**
 * The methods of the Http request.
 */
export declare enum HttpMethod {
    GET = 1,
    POST = 2,
    PUT = 3,
    DELETE = 4,
    PATCH = 5
}
/**
 * Response type of the Http request.
 */
export declare enum ResponseType {
    JSON = 1,
    BLOB = 2,
    ARRAY_BUFFER = 3,
    FORM_DATA = 4,
    TEXT = 5,
    STREAM = 6
}
export declare enum UploadEventType {
    PROGRESS = 1,
    ERROR = 2,
    ABORT = 3,
    COMPLETE = 4
}
/**
 * Type for Http request options.
 */
export interface HttpConfig {
    url: string | string[];
    method?: HttpMethod;
    headers?: any;
    mode?: 'cors' | 'same-origin' | 'no-cors';
    json?: boolean;
    data?: string | Blob | FormData | Object | undefined;
    form?: boolean;
    responseType?: ResponseType;
    upload?: boolean;
    reduce?(httpResponse: HttpResponse<any, any>, state: any): any;
}
export declare enum ResponseObjectType {
    RESPONSE = 1,
    UPLOAD_PROGRESS = 2
}
export interface HttpResponse<T, E> {
    ok: boolean;
    headers: {
        [key: string]: string;
    };
    status: number;
    response: T;
    error: E | null;
    type: ResponseObjectType;
}
export interface HttpUploadProgress {
    percent: number;
    total: number;
    loaded: number;
    cancel(): void;
    type: ResponseObjectType;
}
export declare function ____$_react_mvi_module_reference_bug_fix__dummy_$____(): void;
export interface Fetch {
    (input: RequestInfo, init?: RequestInit): Promise<Response>;
}
export declare type HttpHandlerData = StateHandlerData<any, any>;