npm-min-peer
Version:
Get minimum version required by a peerDependency
30 lines (27 loc) • 878 B
TypeScript
// Generated by dts-bundle-generator v9.5.1
/**
* @internal
*/
export declare function cli(argv: string[]): Promise<number>;
/**
* Options for [[getMinPeer]].
*
* @public
*/
export interface Options {
/** If set it constraints the returned version to this version, i.e. the returned version will be between [N .. N+1] or an error if this major is not supported at all. */
major?: string | number;
/** If enabled the returned string will include the package name, useful when passing the result directly to `npm install` */
withName?: boolean;
/** Filename to read `package.json` from */
pkgFile?: string;
}
/**
* Get minimum version required by a peerDependency.
*
* @public
* @param pkgName - Package name to get version for.
* @param options - Options.
*/
export declare function getMinPeer(pkgName: string, options?: Options): Promise<string>;
export {};