Skip to content

Commit

Permalink
docs: add some fields to the README (#180)
Browse files Browse the repository at this point in the history
  • Loading branch information
jablko authored Jun 1, 2022
1 parent a9a4cdd commit f356cb2
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,7 @@ In addition to the common `package.json` fields, manifests include:
artifact can be found.
* `manifest._from` A normalized form of the spec passed in as an argument.
* `manifest._integrity` The integrity value for the package artifact.
* `manifest._id` The canonical spec of this package version: name@version.
* `manifest.dist` Registry manifests (those included in a packument) have a
`dist` object. Only `tarball` is required, though at least one of
`shasum` or `integrity` is almost always present.
Expand Down Expand Up @@ -274,3 +275,8 @@ For Pacote's purposes, the following fields are relevant:
`foo@latest` gets turned into `[email protected]`.
* `time` In the full packument, an object mapping version numbers to
publication times, for the `opts.before` functionality.

Pacote adds the following fields, regardless of the accept header:

* `_cached` Whether the packument was fetched from the network or the local cache.
* `_contentLength` The size of the packument.

0 comments on commit f356cb2

Please sign in to comment.