scrape-it/lib/index.d.ts

A Node.js scraper for humans.

/// <reference types="cheerio" />

declare namespace scrapeIt {
    export interface ScrapeOptions {
        [key: string]: string | ScrapeOptionList | ScrapeOptionElement;
    }
    export interface ScrapeOptionElement {
        selector?: string;
        convert?: (value: any) => any;
        // using Cheerio type directly from modules it won't show warning types.
        how?: string | ((element: Cheerio) => any);
        attr?: string;
        trim?: boolean;
        closest?: string;
        eq?: number;
        texteq?: number;
    }

    export interface ScrapeOptionList {
        listItem: string;
        data?: ScrapeOptions;
        convert?: (value: any) => any;
    }

    export interface ScrapeResult<T> {
        data: T,
        status: number,
        statusText: string,
        $: Cheerio,
        body: string
    }

    export function scrapeHTML<T>(body: Cheerio | string, options: ScrapeOptions): T;
}

declare function scrapeIt<T>(url: string | object, opts: scrapeIt.ScrapeOptions): Promise<scrapeIt.ScrapeResult<T>>;

export = scrapeIt;