Function search

  • search(site, tags?, searchOptions?): Promise<SearchResults>

  • Searches a site for images with tags and returns the results

    Parameters

    • site: string

      The site to search

    • Optional tags: string | string[] = []

      Tags to search with

    • Optional searchOptions: SearchParameters = {}

      The options for searching if provided (Unused)

    Returns Promise<SearchResults>

    A promise with the images as an array of objects

    Example

    const Booru = require('booru')
    // Returns a promise with the latest cute glace pic from e926
    Booru.search('e926', ['glaceon', 'cute'])

Settings

Member Visibility

Theme