NPM.TypesCompanion (NPM v0.6.0)

Copy Markdown View Source

Suggests @types/* companion packages for dependencies that need TypeScript type definitions.

Summary

Functions

Returns bundled types packages.

Checks if a package typically ships its own types.

Returns packages that are @types/* but whose companion is not installed.

Suggests @types/* packages for dependencies that likely need them.

Returns the @types/* package name for a given package.

Functions

bundled()

@spec bundled() :: [String.t()]

Returns bundled types packages.

has_own_types?(pkg_data)

@spec has_own_types?(map()) :: boolean()

Checks if a package typically ships its own types.

orphaned_types(pkg_data)

@spec orphaned_types(map()) :: [String.t()]

Returns packages that are @types/* but whose companion is not installed.

suggest(pkg_data)

@spec suggest(map()) :: [%{package: String.t(), types_package: String.t()}]

Suggests @types/* packages for dependencies that likely need them.

types_package(scoped)

@spec types_package(String.t()) :: String.t()

Returns the @types/* package name for a given package.