diff --git a/index.d.ts b/index.d.ts index 542d848..53f5ae3 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,20 +1,22 @@ import {Plugin} from 'rollup'; import {AsyncOpts} from 'resolve'; -interface RollupNodeResolveOptions { +export interface Options { /** * the fields to scan in a package.json to determine the entry point * if this list contains "browser", overrides specified in "pkg.browser" * will be used * @default ['module', 'main'] */ - mainFields?: string[], + mainFields?: string[]; + /** * @deprecated use "mainFields" instead * use "module" field for ES6 module if possible * @default true */ module?: boolean; + /** * @deprecated use "mainFields" instead * use "jsnext:main" if possible @@ -24,6 +26,7 @@ interface RollupNodeResolveOptions { * @default false */ jsnext?: boolean; + /** * @deprecated use "mainFields" instead * use "main" field or index.js, even if it's not an ES6 module @@ -32,6 +35,7 @@ interface RollupNodeResolveOptions { * @default true */ main?: boolean; + /** * some package.json files have a "browser" field which specifies * alternative files to load for people bundling for the browser. If @@ -40,23 +44,27 @@ interface RollupNodeResolveOptions { * @default false */ browser?: boolean; + /** * not all files you want to resolve are .js files * @default [ '.mjs', '.js', '.json', '.node' ] */ extensions?: ReadonlyArray; + /** * whether to prefer built-in modules (e.g. `fs`, `path`) or * local ones with the same names * @default true */ preferBuiltins?: boolean; + /** * Lock the module search in this path (like a chroot). Module defined * outside this path will be marked as external * @default '/' */ jail?: string; + /** * Set to an array of strings and/or regexps to lock the module search * to modules that match at least one entry. Modules not matching any @@ -64,18 +72,21 @@ interface RollupNodeResolveOptions { * @default null */ only?: ReadonlyArray | null; + /** * If true, inspect resolved files to check that they are * ES2015 modules * @default false */ modulesOnly?: boolean; + /** * Force resolving for these modules to root's node_modules that helps * to prevent bundling the same package multiple times if package is * imported from dependencies. */ dedupe?: string[]; + /** * Any additional options that should be passed through * to node-resolve @@ -86,4 +97,4 @@ interface RollupNodeResolveOptions { /** * Locate modules using the Node resolution algorithm, for using third party modules in node_modules */ -export default function nodeResolve(options?: RollupNodeResolveOptions): Plugin; +export default function nodeResolve(options?: Options): Plugin;