fetch-pkg
v1.0.0
Published
Fetch packages from any npm-compatible registries
Downloads
14
Maintainers
Readme
fetch-pkg
Fetch packages from any npm-compatible registries.
Installation
$ npm install fetch-pkg --save # npm
$ yarn add fetch-pkg # Yarn
Usage
import fs from "fs";
import { fetchPkg } from "fetch-pkg";
fetchPkg("fetch-pkg")
.then(pkg =>
pkg
.pipe(fs.createWriteStream("inception.tgz"))
.once("finish", () => process.exit(0))
)
.catch(err => {
console.error(err);
process.exit(1);
});
API
fetchPkg(name: string, opts?: Options): Promise<Pkg>
Fetch a package from an npm-compatible registry and return the fetch package metadata and tarball stream.
Pkg
Extends: stream.Readable
name
- Type:
string
The fetched package name.
version
- Type:
string
The fetched package version.
Options
registryURL
- Type:
string
- Default:
https://registry.npmjs.org/
The package registry URL. For example, to fetch a package from the GitHub Package Registry you should use https://npm.pkg.github.com.
token
- Type:
string
The authentication token.
version
- Type:
string
- Default:
latest
The package version to fetch, a valid semver range or a dist tag.
Errors
FetchPkgError
: This error is thrown when something went wrong with the HTTP requests.PackageNotFoundError
: This error is thrown when the given package name cannot be found.PackageVersionNotFoundError
: This error is thrown when the given package version cannot be found.
Contributing
Contributions are welcome!
Want to file a bug, request a feature or contribute some code?
- Check out the Code of Conduct
- Check for an existing issue matching your bug or feature request
- Open an issue describing your bug or feature request
- Open a pull request if you want to contribute some code.
License
MIT © kevinpollet