1NPM-SHRINKWRAP.JSON(5) NPM-SHRINKWRAP.JSON(5)
2
3
4
6 npm-shrinkwrap.json - A publishable lockfile
7
8 Description
9 npm-shrinkwrap.json is a file created by npm help shrinkwrap. It is
10 identical to package-lock.json, with one major caveat: Unlike package-
11 lock.json, npm-shrinkwrap.json may be included when publishing a pack‐
12 age.
13
14 The recommended use-case for npm-shrinkwrap.json is applications de‐
15 ployed through the publishing process on the registry: for example,
16 daemons and command-line tools intended as global installs or devDepen‐
17 dencies. It's strongly discouraged for library authors to publish this
18 file, since that would prevent end users from having control over tran‐
19 sitive dependency updates.
20
21 If both package-lock.json and npm-shrinkwrap.json are present in a
22 package root, npm-shrinkwrap.json will be preferred over the package-
23 lock.json file.
24
25 For full details and description of the npm-shrinkwrap.json file for‐
26 mat, refer to the manual page for package-lock.json ⟨/configuring-
27 npm/package-lock-json⟩.
28
29 See also
30 • npm help shrinkwrap
31
32 • package-lock.json ⟨/configuring-npm/package-lock-json⟩
33
34 • package.json ⟨/configuring-npm/package-json⟩
35
36 • npm help install
37
38
39
40 November 2023 NPM-SHRINKWRAP.JSON(5)