Skip to content

Commit

Permalink
docs(package-lock): Added package-lock resolved example (#250)
Browse files Browse the repository at this point in the history
docs(package-lock): Added package-lock resolved ex

Added a concrete example on how the url from the resolved field of a
package-lock.json file will be used along with the configured registry
value in order to build the URL for that package.
  • Loading branch information
ruyadorno authored Sep 18, 2019
1 parent b4ff454 commit 752652e
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions doc/spec/package-lock.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,24 @@ this resource.
URL. If the tarball URL isn't on the same server as the registry URL then
this is a complete URL.

eg, Given a `package-lock.json` file containing:

```
"resolved": "https://registry.npmjs.org/example/-/example-1.0.0.tgz"
```

and a registry source configuring a custom value:

```
npm install --registry https://registry.example.com
```

the package will be fetched from the custom-defined registry:

```
https://registry.example.com/example/-/example-1.0.0.tgz
```

#### link *(new)*

If this module was symlinked in development but had semver in the
Expand Down

0 comments on commit 752652e

Please sign in to comment.