browserslist

Variables

• aliases
• cache
• data
• defaults
• desktopNames
• nodeVersions
• usage
• versionAliases

Functions

• browserslist()
• clearCaches()
• coverage()
• findConfig()
• findConfigFile()
• loadConfig()
• parse()
• parseConfig()
• readConfig()

Interfaces

• LoadConfigOptions

  • config
  • env
  • path
• Options

  • config
  • dangerousExtend
  • env
  • ignoreUnknownVersions
  • mobileToDesktop
  • path
  • stats
  • throwOnMissing
• Query

  • compose
  • not
  • query
  • type
• Stats
• Usage

Type Aliases

• Config
• StatsOptions

Namespaces

• global
• global.NodeJS

  • ProcessEnv

variable aliases

let aliases: { [alias: string]: string };

• Browser names aliases.

variable cache

let cache: { [feature: string]: { [name: string]: { [version: string]: string } } };

variable data

let data: {
    [browser: string]: {
        name: string;
        versions: string[];
        released: string[];
        releaseDate: { [version: string]: number };
    };
};

variable defaults

let defaults: readonly string[];

• Default browsers query

variable desktopNames

let desktopNames: { [browser: string]: string };

• Can I Use only provides a few versions for some browsers (e.g. and_chr).

  Fallback to a similar browser for unknown versions.

variable nodeVersions

let nodeVersions: string[];

variable usage

let usage: { [country: string]: Usage; global?: Usage; custom?: Usage | null };

variable versionAliases

let versionAliases: { [browser: string]: { [version: string]: string } };

• Aliases to work with joined versions like ios_saf 7.0-7.1.

function browserslist

browserslist: typeof browserslist;

• Return array of browsers by selection queries.

  browserslist('IE >= 10, IE 8') //=> ['ie 11', 'ie 10', 'ie 8']

  Parameter queries

  Browser queries.

  Parameter opts

  Options.

  Returns

  Array with browser names in Can I Use.

function clearCaches

clearCaches: () => void;

function coverage

coverage: (browsers: readonly string[], stats?: StatsOptions) => number;

• Return browsers market coverage.

  browserslist.coverage(browserslist('> 1% in US'), 'US') //=> 83.1

  Parameter browsers

  Browsers names in Can I Use.

  Parameter stats

  Which statistics should be used.

  Returns

  Total market coverage for all selected browsers.

function findConfig

findConfig: (...pathSegments: string[]) => Config | undefined;

function findConfigFile

findConfigFile: (...pathSegments: string[]) => string | undefined;

function loadConfig

loadConfig: (options: LoadConfigOptions) => string[] | undefined;

• Return queries for specific file inside the project.

  browserslist.loadConfig({
    file: process.cwd()
  }) ?? browserslist.defaults

function parse

parse: (
    queries?: string | readonly string[] | null,
    opts?: browserslist.Options
) => Query[];

• Get queries AST to analyze the config content.

  Parameter queries

  Browser queries.

  Parameter opts

  Options.

  Returns

  An array of the data of each query in the config.

function parseConfig

parseConfig: (string: string) => Config;

function readConfig

readConfig: (file: string) => Config;

type Config

type Config = {
    defaults: string[];
    [section: string]: string[] | undefined;
};

type StatsOptions

type StatsOptions = string | 'my stats' | Stats | { dataByBrowser: Stats };

• Which statistics should be used. Country code or custom statistics. Pass "my stats" to load statistics from Browserslist files.