duck-duck-scrape/lib/search/images.d.ts

Search from DuckDuckGo and use it's spice APIs.

import { NeedleOptions } from 'needle';
import { DuckbarImageResult } from '../types';
import { SafeSearchType } from '../util';
/** The types of image sizes. */
export declare enum ImageSize {
    /** Any size. */
    ALL = "",
    /** Small size, less than 200x200. */
    SMALL = "Small",
    /** Medium size, approx. between 200x200 and 500x500. */
    MEDIUM = "Medium",
    /** Large size, approx. between 500x500 and 2000x2000. */
    LARGE = "Large",
    /** Wallpaper size, larger than 1200x1200. */
    WALLPAPER = "Wallpaper"
}
/** The types of images. */
export declare enum ImageType {
    /** Any images. */
    ALL = "",
    /** Any regular photos. */
    PHOTOGRAPH = "photo",
    /** Clipart. */
    CLIPART = "clipart",
    /** Animated GIFs. */
    GIF = "gif",
    /** Transparent photos. */
    TRANSPARENT = "transparent"
}
/** The types of image layouts. */
export declare enum ImageLayout {
    /** Any size of images. */
    ALL = "",
    /** Square images. Images may not be exactly square. */
    SQUARE = "Square",
    /** Tall images. More height than width. */
    TALL = "Tall",
    /** Wide images. More width than height. */
    WIDE = "Wide"
}
/** The types of image colors. */
export declare enum ImageColor {
    /** Any image. */
    ALL = "",
    /** Any image with color. */
    COLOR = "color",
    /** Any monochome images. */
    BLACK_AND_WHITE = "Monochrome",
    /** Mostly red images. */
    RED = "Red",
    /** Mostly orange images. */
    ORANGE = "Orange",
    /** Mostly yellow images. */
    YELLOW = "Yellow",
    /** Mostly green images. */
    GREEN = "Green",
    /** Mostly blue images. */
    BLUE = "Blue",
    /** Mostly pink images. */
    PINK = "Pink",
    /** Mostly brown images. */
    BROWN = "Brown",
    /** Mostly black images. */
    BLACK = "Black",
    /** Mostly gray images. */
    GRAY = "Gray",
    /** Alias for `GRAY`. */
    GREY = "Gray",
    /** Mostly teal images. */
    TEAL = "Teal",
    /** Mostly white images. */
    WHITE = "White"
}
/** The types of image licenses. */
export declare enum ImageLicense {
    /** Any image license. */
    ALL = "",
    /** All Creative Commons. */
    CREATIVE_COMMONS = "Any",
    /** Public Domain images. */
    PUBLIC_DOMAIN = "Public",
    /** Free to share and use. */
    SHARE = "Share",
    /** Free to share and use commercially. */
    SHARE_COMMERCIALLY = "ShareCommercially",
    /** Free to modify, share, and use. */
    MODIFY = "Modify",
    /** Free to modify, share, and use commercially. */
    MODIFY_COMMERCIALLY = "ModifyCommercially"
}
/** The options for {@link searchImages}. */
export interface ImageSearchOptions {
    /** The safe search type of the search. */
    safeSearch?: SafeSearchType;
    /** The locale(?) of the search. Defaults to "en-us". */
    locale?: string;
    /** The number to offset the results to. */
    offset?: number;
    /**
     * The string that acts like a key to a search.
     * Set this if you made a search with the same query.
     */
    vqd?: string;
    /** The color filter of the images. */
    color?: ImageColor;
    /** The layout of the images to search. */
    layout?: ImageLayout;
    /** The size filter of the images to search. */
    size?: ImageSize;
    /** The type of the images to search. */
    type?: ImageType;
    /** The license of the images to search. */
    license?: ImageLicense;
}
/** The search results from {@link searchImages}. */
export interface ImageSearchResults {
    /** Whether there were no results found. */
    noResults: boolean;
    /** The VQD of the search query. */
    vqd: string;
    /** The image results of the search. */
    results: DuckbarImageResult[];
}
/**
 * Search images.
 * @category Search
 * @param query The query to search with
 * @param options The options of the search
 * @param needleOptions The options of the HTTP request
 * @returns Search results
 */
export declare function searchImages(query: string, options?: ImageSearchOptions, needleOptions?: NeedleOptions): Promise<ImageSearchResults>;