Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add some fields to the README #180

Merged
merged 1 commit into from
Jun 1, 2022
Merged

docs: add some fields to the README #180

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
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.