transporters.d.ts•1.32 kB
import { Gaxios, GaxiosError, GaxiosOptions, GaxiosPromise, GaxiosResponse } from 'gaxios';
export interface Transporter {
defaults?: GaxiosOptions;
request<T>(opts: GaxiosOptions): GaxiosPromise<T>;
}
export interface BodyResponseCallback<T> {
(err: Error | null, res?: GaxiosResponse<T> | null): void;
}
export interface RequestError extends GaxiosError {
errors: Error[];
}
export declare class DefaultTransporter implements Transporter {
/**
* Default user agent.
*/
static readonly USER_AGENT: string;
/**
* A configurable, replacable `Gaxios` instance.
*/
instance: Gaxios;
/**
* Configures request options before making a request.
* @param opts GaxiosOptions options.
* @return Configured options.
*/
configure(opts?: GaxiosOptions): GaxiosOptions;
/**
* Makes a request using Gaxios with given options.
* @param opts GaxiosOptions options.
* @param callback optional callback that contains GaxiosResponse object.
* @return GaxiosPromise, assuming no callback is passed.
*/
request<T>(opts: GaxiosOptions): GaxiosPromise<T>;
get defaults(): GaxiosOptions;
set defaults(opts: GaxiosOptions);
/**
* Changes the error to include details from the body.
*/
private processError;
}