webhead/dist/webhead.d.ts

An easy-to-use Node web crawler storing cookies, following redirects, traversing pages and submitting forms.

type Headers = Record<string, string>;

export interface AnyObject {
  [key: string]: any;
}

export interface WebheadOptions {
  jarFile?: string;
  userAgent?: string;
  verbose?: boolean;
  beforeSend?: (
    parameters: WebheadRequestParameters,
    session: AnyObject,
  ) => WebheadRequestParameters;
  complete?: (
    parameters: WebheadRequestParameters,
    session: AnyObject,
    webhead: WebheadInstance,
  ) => void;
}

export interface WebheadRequestParameters {
  method: string;
  url: string;
  options: WebheadRequestOptions;
}

export interface WebheadRequestOptions {
  headers?: Headers;
  data?: object;
  multiPartData?: object;
  json?: object;
}

export interface WebheadResponse {
  statusCode: number;
  headers: Headers;
  data?: string;
}

export interface WebheadInstance {
  get(url: string, options?: WebheadRequestOptions): Promise<WebheadResponse>;
  post(url: string, options?: WebheadRequestOptions): Promise<WebheadResponse>;
  put(url: string, options?: WebheadRequestOptions): Promise<WebheadResponse>;
  patch(url: string, options?: WebheadRequestOptions): Promise<WebheadResponse>;
  delete(url: string, options?: WebheadRequestOptions): Promise<WebheadResponse>;
  head(url: string, options?: WebheadRequestOptions): Promise<WebheadResponse>;
  options(url: string, options?: WebheadRequestOptions): Promise<WebheadResponse>;
  text(): string;
  json(): any;
  $(html: string | Buffer, options?: cheerio.CheerioParserOptions): cheerio.Root | [];
  $(element: Element, options?: cheerio.CheerioParserOptions): cheerio.Root | [];
  submit(url: string, formData: object): Promise<WebheadResponse>;
  clearCookies(): void;
  url?: URL;
}

export default function Webhead(options?: WebheadOptions): WebheadInstance;