crawlee-http-client.api

Public API Report File for "@crawlee/http-client"

Do not edit this file. It is a report generated by API Extractor.

import type { BaseHttpClient as BaseHttpClient_2 } from '@crawlee/types';
import type { CookieJar } from '@crawlee/types';
import type { CrawleeLogger } from '@crawlee/types';
import type { SendRequestOptions } from '@crawlee/types';
import type { SessionFingerprint } from '@crawlee/types';

// @public
export abstract class BaseHttpClient implements BaseHttpClient_2 {
    constructor(options?: {
        logger?: CrawleeLogger;
    });
    protected abstract fetch(input: Request, init?: RequestInit & CustomFetchOptions): Promise<Response>;
    sendRequest(initialRequest: Request, options?: SendRequestOptions): Promise<Response>;
}

// @public
export interface CustomFetchOptions {
    cookieJar?: CookieJar;
    fingerprint?: SessionFingerprint;
    ignoreTlsErrors?: boolean;
    proxyUrl?: string;
}

// @public
export class FetchHttpClient extends BaseHttpClient {
    constructor(options?: {
        logger?: CrawleeLogger;
    });
    // (undocumented)
    fetch(request: Request, options?: RequestInit & CustomFetchOptions): Promise<Response>;
}

// @public (undocumented)
export interface IResponseWithUrl extends Response {
    // (undocumented)
    url: string;
}

// @public
export class ResponseWithUrl extends Response implements IResponseWithUrl {
    constructor(body: BodyInit | null, init: ResponseInit & {
        url?: string;
    });
    // (undocumented)
    url: string;
}

// (No @packageDocumentation comment for this package)