UNPKG

urban-scraper

Version:

A package for scraping terms and their definitions from the [Urban Dictionary](https://www.urbandictionary.com/).

github.com/itsbrunodev/urban-scraper

11 lines (10 loc) • 532 B
1
2
3
4
5
6
7
8
9
10
11
import { Options, Term } from "./types"; export { Options, Term }; export declare function getTerm(query: string, options?: Options): Promise<Term>; export declare function getTerm(query: string[], options?: Options): Promise<Term[]>; /** * Get a random term with its description and the example from the urban dictionary * @param {boolean} formatMarkdown - Whether to format the term description and the example for markdown * @example await getRandom(); */ export declare function getRandom(options?: Options): Promise<Term>;