NPM.PlatformOptional (NPM v0.7.0)

Copy Markdown View Source

Selects optional dependencies that match the current platform.

Many npm packages publish one optional package per operating system and CPU, for example native bindings for Linux, macOS, Windows, x64, or arm64. The lockfile can contain all of those packages for portability, but linking should only install the package that can run on the current machine.

This module groups platform-specific package families and keeps the best match for the current OS/CPU while leaving ordinary optional dependencies untouched.

Summary

Functions

current_match(name)
select(optional_dependencies)

Functions

current_match(name)

@spec current_match(String.t()) :: boolean()

select(optional_dependencies)

@spec select(map()) :: map()