interface Osmosis {
    /**
     * define domain where osmosis is parsing data from
     */
    get(url: string): Osmosis;

    /**
     * set scrapped data as result,
     * 1. string, after find function set data by selector as value with this string as key
     * 2. object, define any json object
     */
    set(json: string | {}): Osmosis;

    /**
     * find DOM by selector
     */
    find(selector: string): Osmosis;

    /**
     * follw links, founded href or src
     * @param selector '@href' or '@src', default '@href'
     */
    follow(selector: string): Osmosis;

    /**
     * paginate followed url
     */
    paginate(selector: string): Osmosis;

    /**
     * passing string to your function
     * log data
     */
    log(callback: (param: string) => any): Osmosis;

    /**
     * passing string to your function
     * debug data
     */
    debug(callback: (param: string) => any): Osmosis;

    /**
     * passing string to your function
     * error data
     */
    error(callback: (param: string) => any): Osmosis;

    /**
     * passing string to your function
     * result data, osmosis finished
     */
    data(callback: (param: any) => any): Osmosis;

    /**
     * Set configuration options for the **preceeding** command on down the chain.
     */
    config(option: string | { [key: string]: any }, value?: any): Osmosis;

    /**
     * Set a cookie. Short for `.config({ cookies: ... })`. Note: Setting a cookie to `null` will delete the cookie.
     */
    cookie(name: string, value: string | null): Osmosis;

    /**
     * Set an HTTP header. Short for `.config({ headers: ... })`
     */
    header(name: string, value: string): Osmosis;

    /**
     * Set multiple HTTP headers. Short for `.config({ headers: ... })`.
     */
    headers(headers: { [key: string]: string }): Osmosis;

    /**
     * Call a callback when the Osmosis instance has completely finished.
     */
    done(callback: () => any): Osmosis;
}

declare const osmosis: Osmosis;

export = osmosis;

Additional Details

Last updated: Tue, 07 Nov 2023 0939 GMT
Dependencies: none

Credits

These definitions were written by Juraj Kočan, and Evan Shortiss.