Interface SearchOptions

The options for search.

interface SearchOptions {
    locale?: string;
    marketRegion?: string;
    offset?: number;
    region?: string;
    safeSearch?: SafeSearchType;
    time?: string;
    vqd?: string;
}

Properties

locale? marketRegion? offset? region? safeSearch? time? vqd?

Properties

Optionallocale

locale?: string

The locale(?) of the search. Defaults to "en-us".

OptionalmarketRegion

marketRegion?: string

The market region(?) of the search. Defaults to "US".

Optionaloffset

offset?: number

The number to offset the results to.

Optionalregion

region?: string

The region of the search. Defaults to "wt-wt" or all regions.

OptionalsafeSearch

safeSearch?: SafeSearchType

The safe search type of the search.

Optionaltime

time?: string

The time range of the searches, can be a SearchTimeType or a date range ("2021-03-16..2021-03-30")

Optionalvqd

vqd?: string

The string that acts like a key to a search. Set this if you made a search with the same query.

Settings

Member Visibility

On This Page

Properties