NPM.Outdated (NPM v0.6.0)

Checks for outdated packages by comparing installed versions against the latest available versions on the registry.

Summary

Types

outdated_entry()

Functions

check(lockfile, deps, latest_versions)

Checks a lockfile against wanted ranges and latest versions.

filter_by_type(entries, type)

Filters outdated entries by update type.

format_entry(entry)

Formats an outdated entry as a human-readable string.

summary(entries)

Returns a summary of outdated packages.

Types

outdated_entry()

@type outdated_entry() :: %{
  name: String.t(),
  current: String.t(),
  wanted: String.t(),
  latest: String.t(),
  type: :major | :minor | :patch | :current
}

Functions

check(lockfile, deps, latest_versions)

@spec check(map(), map(), map()) :: [outdated_entry()]

Checks a lockfile against wanted ranges and latest versions.

Given a lockfile (installed versions) and deps (wanted ranges from package.json), and a map of latest versions from the registry, returns a list of outdated entries.

filter_by_type(entries, type)

@spec filter_by_type([outdated_entry()], :major | :minor | :patch) :: [
  outdated_entry()
]

Filters outdated entries by update type.

format_entry(entry)

@spec format_entry(outdated_entry()) :: String.t()

Formats an outdated entry as a human-readable string.

summary(entries)

@spec summary([outdated_entry()]) :: %{
  total: non_neg_integer(),
  major: non_neg_integer(),
  minor: non_neg_integer(),
  patch: non_neg_integer()
}

Returns a summary of outdated packages.