lifion-verify-deps/lib/index.d.ts

Verifies that installed NPM modules are the latest currently available version.

export = verifyDeps;
/**
 * Verifies the dependencies listed in the package.json of the given directory.
 *
 * @alias module:lifion-verify-deps
 * @param {Object} [options] - Optional parameters.
 * @param {boolean} [options.autoUpgrade=false] - Automatically upgrade all suggested dependencies.
 * @param {string} [options.dir] - The path where to look for the package.json file.
 * @param {Logger} [options.logger] - A logger instance, with a similar API as the console object.
 */
declare function verifyDeps({
  autoUpgrade,
  dir,
  logger
}?:
  | {
      autoUpgrade?: boolean | undefined;
      dir?: string | undefined;
      logger?: Logger | undefined;
    }
  | undefined): Promise<void>;
declare namespace verifyDeps {
  export { Logger, PackageStatus };
}
type Logger = {
  /**
   * - Prints standard output with newline.
   */
  debug: Function;
  /**
   * - Prints standard error with newline.
   */
  error: Function;
  /**
   * - Prints standard output with newline.
   */
  info: Function;
  /**
   * - Prints standard error with newline.
   */
  warn: Function;
};
type PackageStatus = {
  /**
   * - Currently installed version.
   */
  installed: string | null;
  /**
   * - Latest version available.
   */
  latest: string;
  /**
   * - Module name.
   */
  name: string;
  /**
   * - If module should be installed.
   */
  shouldBeInstalled: boolean;
  /**
   * - Module type.
   */
  type: string;
  /**
   * - Version from package.json.
   */
  wanted: string;
};