NPM.OptionalDeps (NPM v0.6.0)

Handles optionalDependencies in package.json.

Optional dependencies are installed if available but installation failures are ignored. Common for platform-specific packages.

Summary

Separates installed from missing optional deps.

extract(arg1)

Extracts optionalDependencies from package.json data.

Returns optional deps that are relevant for the current platform.

Checks if a package is an optional dependency.

Formats a summary of optional dependencies.

@spec check_installed(map(), map()) :: %{
  installed: [String.t()],
  missing: [String.t()]
}

Separates installed from missing optional deps.

@spec extract(map()) :: map()

Extracts optionalDependencies from package.json data.

@spec for_platform(map(), String.t(), String.t()) :: map()

Returns optional deps that are relevant for the current platform.

@spec optional?(String.t(), map()) :: boolean()

Checks if a package is an optional dependency.

@spec summary(map()) :: %{total: non_neg_integer(), names: [String.t()]}

Formats a summary of optional dependencies.