interface _GetOptions {
    includeBlocked?: boolean;
    includeFavicon?: boolean;
    includePinned?: boolean;
    includeSearchShortcuts?: boolean;
    limit?: number;
    newtab?: boolean;
    onePerDomain?: boolean;
    providers?: string[];
}
Index
includeBlocked? includeFavicon? includePinned? includeSearchShortcuts? limit? newtab? onePerDomain? providers?
includeBlocked?: boolean

Include sites that the user has blocked from appearing on the Firefox new tab.

includeFavicon?: boolean

Include sites favicon if available.

includePinned?: boolean

Include sites that the user has pinned on the Firefox new tab.

includeSearchShortcuts?: boolean

Include search shortcuts appearing on the Firefox new tab.

limit?: number

The number of top sites to return, defaults to the value used by Firefox

newtab?: boolean

Return the sites that exactly appear on the user's new-tab page. When true, all other options are ignored except limit and includeFavicon. If the user disabled newtab Top Sites, the newtab parameter will be ignored.

onePerDomain?: boolean

Limit the result to a single top site link per domain

providers?: string[]

Please use the other options to tune the results received from topSites.