You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

49 lines
1.3 KiB

1 month ago
import type { ModuleName, Target, TargetVersion } from "./shared";
type StringOrRegExp = string | RegExp;
type Modules = StringOrRegExp | readonly StringOrRegExp[];
type BrowserslistQuery = string | ReadonlyArray<string>;
type Environments = {
[target in Target]?: string | number;
};
type Targets = Environments & {
browsers?: Environments | BrowserslistQuery,
esmodules?: boolean,
};
type CompatOptions = {
/** entry / module / namespace / an array of them, by default - all `core-js` modules */
modules?: Modules,
/** a blacklist, entry / module / namespace / an array of them, by default - empty list */
exclude?: Modules,
/** optional browserslist or core-js-compat format query */
targets?: Targets | BrowserslistQuery,
/** used `core-js` version, by default the latest */
version?: string,
/** inverse of the result, shows modules that are NOT required for the target environment */
inverse?: boolean,
/**
* @deprecated use `modules` instead
*/
filter?: Modules
};
type CompatOutput = {
/** array of required modules */
list: ModuleName[],
/** object with targets for each module */
targets: {
[module: ModuleName]: {
[target in Target]?: TargetVersion
}
}
}
declare function compat(options?: CompatOptions): CompatOutput;
export = compat;