@busymango/fetch-driver/dist/src/types.d.ts

import { DriveContext } from './context';
export type Next = () => Promise<void>;
export type ReadableValue = ReadableStreamReadValueResult<Uint8Array<ArrayBufferLike>>;
export declare abstract class DriverHooks {
    abstract beforeInit?(ctx: DriveContext): Promise<void>;
    abstract afterInit?(ctx: DriveContext): Promise<void>;
    abstract beforeFetch?(ctx: DriveContext): Promise<void>;
    abstract afterFetch?(ctx: DriveContext): Promise<void>;
    abstract beforeParse?(ctx: DriveContext): Promise<void>;
    abstract afterParse?(ctx: DriveContext): Promise<void>;
}
export type Middleware<T> = (context: T, next: Next) => Promise<void>;
export type MiddlewarePattern = string | ((ctx: ReturnType<DriveContext["clone"]>) => boolean);
export type DriverMiddleware<T = unknown> = Middleware<DriveContext<T>>;
export type UseDriverMiddleware<T = unknown> = [
    MiddlewarePattern,
    DriverMiddleware<T>
];
export type DriverParams = UseDriverMiddleware[] | {
    use?: UseDriverMiddleware[];
    hooks?: DriverHooks;
    randomId?: () => string;
    parser?: <T>() => BodyParseFunc<T>;
    stringify?: DataStringifyFunc;
};
export type DriverRequest = {
    id: string;
    headers: Headers;
} & Omit<RequestInit, "headers">;
export interface ReceiverFunc<T> {
    (params: {
        size: number;
        done: boolean;
        percentage: number;
        context: DriveContext<T>;
        reader: ReadableStreamDefaultReader<Uint8Array>;
        value?: Uint8Array;
    }): void;
}
export interface BodyParseFunc<T> {
    (response: Response, context: DriveContext<T>, extra?: {
        attchment?: boolean;
        receiver?: ReceiverFunc<T>;
    }): Promise<void>;
}
export interface DataStringifyFunc {
    (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
    (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
}
export type ExtraOptions<T> = {
    /** abort fetch before timeout */
    timeout?: number;
    /** force parse response as attachment */
    attchment?: boolean;
    /** use extra middleware in current fetch */
    use?: DriverMiddleware<T>[];
    /** progress callback */
    receiver?: ReceiverFunc<T>;
    /** body parse */
    parse?: BodyParseFunc<T>;
    /** data stringify */
    stringify?: DataStringifyFunc;
};
export type DriverOptions<T> = RequestInit & ExtraOptions<T> & {
    api: string;
    data?: object;
};
export interface DriverMethodFunc {
    <T>(api: string, data?: object, init?: Omit<RequestInit, "method"> & ExtraOptions<T>): Promise<T>;
}
export type DriveFuncAttrs = Record<Lowercase<FetchMethod>, DriverMethodFunc>;
export interface DriveFunc extends DriveFuncAttrs {
    <T>(opts: DriverOptions<T>): Promise<T>;
    <T>(
    /** the fetch USVString */
    api: string, 
    /** the fetch body */
    data?: object, 
    /** the fetch request init */
    init?: RequestInit & ExtraOptions<T>): Promise<T>;
}
export type FirstParam<T> = string | DriverOptions<T>;
export type FetchContext<T> = Required<DriveContext<T>>;
export type FetchMethod = "GET" | "PUT" | "POST" | "HEAD" | "TRACE" | "PATCH" | "DELETE" | "CONNECT" | "OPTIONS";
export declare const methods: readonly FetchMethod[];