NPM.PeerDep (NPM v0.6.0)

Copy Markdown View Source

Analyzes peer dependency declarations and their resolution status.

Summary

Functions

Counts total peer dependencies across packages.

Extracts peer dependencies from package.json data.

Extracts peerDependenciesMeta (optional markers).

Checks if a peer dependency is marked as optional.

Returns required (non-optional) peer dependencies.

Checks if all required peers are satisfied in the lockfile.

Lists unsatisfied peer dependencies.

Functions

count_across(packages)

@spec count_across([map()]) :: non_neg_integer()

Counts total peer dependencies across packages.

extract(arg1)

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

Extracts peer dependencies from package.json data.

meta(arg1)

@spec meta(map()) :: map()

Extracts peerDependenciesMeta (optional markers).

optional?(name, data)

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

Checks if a peer dependency is marked as optional.

required(data)

@spec required(map()) :: map()

Returns required (non-optional) peer dependencies.

satisfied?(data, lockfile)

@spec satisfied?(map(), map()) :: boolean()

Checks if all required peers are satisfied in the lockfile.

unsatisfied(data, lockfile)

@spec unsatisfied(map(), map()) :: [{String.t(), String.t(), String.t() | nil}]

Lists unsatisfied peer dependencies.