Go to main content

man pages section 5: File Formats

Exit Print View

Updated: Thursday, June 13, 2019
 
 

npm-shrinkwrap.json (5)

Name

npm-shrinkwrap.json - A publishable lockfile

Synopsis

Please see following description for synopsis

Description

NPM-SHRINKWRAP.JSON(5)                                  NPM-SHRINKWRAP.JSON(5)



NAME
       npm-shrinkwrap.json - A publishable lockfile

DESCRIPTION
       npm-shrinkwrap.json  is  a  file  created by npm help shrinkwrap. It is
       identical to package-lock.json, with one  major  caveat:  Unlike  pack-
       age-lock.json,  npm-shrinkwrap.json  may  be included when publishing a
       package.

       The  recommended  use-case  for  npm-shrinkwrap.json  is   applications
       deployed  through  the publishing process on the registry: for example,
       daemons and command-line tools intended as global installs or devDepen-
       dencies.  It's strongly discouraged for library authors to publish this
       file, since that would prevent end users from having control over tran-
       sitive dependency updates.

       Additionally,  if  both  package-lock.json  and npm-shrinkwrap.json are
       present in a package root, package-lock.json will be ignored  in  favor
       of this file.

       For  full  details and description of the npm-shrinkwrap.json file for-
       mat, refer to the manual page for npm help 5 package-lock.json.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-------------------------+
       |ATTRIBUTE TYPE |    ATTRIBUTE VALUE      |
       +---------------+-------------------------+
       |Availability   | runtime/nodejs/nodejs-8 |
       +---------------+-------------------------+
       |Stability      | Pass-thru volatile      |
       +---------------+-------------------------+
SEE ALSO
       o npm help shrinkwrap

       o npm help 5 package-lock.json

       o npm help 5 package.json

       o npm help install




NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from     https://github.com/nodejs/node/ar-
       chive/v8.15.1.zip

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                  August 2018           NPM-SHRINKWRAP.JSON(5)