Variable default

Type declaration

• configuration: {
      createConfig: ((config: Config) => Config);
      createFileReader: ((absoluteFilePath: string) => FileReader);
  }

  • createConfig: ((config: Config) => Config)

    • • (config: Config): Config

      • Validates a raw configuration file and generates a report if any rules are misconfigured.

        Parameters

        • config: Config

          rotten deps configuration object

        Returns Config

  • createFileReader: ((absoluteFilePath: string) => FileReader)

    • • (absoluteFilePath: string): FileReader

      • Creates a filereader function for fetching the contents of a config file at the provided path.

        Parameters

        • absoluteFilePath: string

          absolute path to the configuration file

        Returns FileReader

• generateReport: ((c: Config, r?: Reporter) => Promise<Error | ReportResponse>)

  • • (c: Config, r?: Reporter): Promise<Error | ReportResponse>

    • Compares the details on each dependency flagged as outdated in order to determine how stale a version actually is.

      Parameters

      • c: Config

      • Optional r: Reporter

        Optional reporter object with functions for hooking middleware into the report generation process

      Returns Promise<Error | ReportResponse>

• npm: {
      createDetailsRequest: ((dependencyName: string) => DetailsRequest);
      createOutdatedRequest: (() => OutdatedRequest);
  }

  • createDetailsRequest: ((dependencyName: string) => DetailsRequest)

    • • (dependencyName: string): DetailsRequest

      • Creates a function to run the npm view command for a specific dependency

        Parameters

        • dependencyName: string

        Returns DetailsRequest

  • createOutdatedRequest: (() => OutdatedRequest)

    • • (): OutdatedRequest

      • Creates a function for running npm outdated

        Returns OutdatedRequest