NPM.SideEffects (NPM v0.6.0)

Copy Markdown View Source

Analyzes the sideEffects field from package.json.

Used by bundlers (webpack, rollup, esbuild) for tree-shaking.

Summary

Functions

Checks if a specific file has side effects.

Returns files with side effects (when sideEffects is an array).

Extracts the sideEffects value.

Checks if the package declares any side effects.

Counts tree-shakeable packages.

Checks if the package is fully tree-shakeable (sideEffects: false).

Functions

file_has_side_effects?(file, arg2)

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

Checks if a specific file has side effects.

files_with_side_effects(arg1)

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

Returns files with side effects (when sideEffects is an array).

get(arg1)

@spec get(map()) :: boolean() | [String.t()] | nil

Extracts the sideEffects value.

has_side_effects?(arg1)

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

Checks if the package declares any side effects.

stats(packages)

@spec stats([map()]) :: map()

Counts tree-shakeable packages.

tree_shakeable?(arg1)

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

Checks if the package is fully tree-shakeable (sideEffects: false).