@tunnckocore/package-json
Get package.json metadata for npm module from JSDelivr or fallback to Unpkg, because the npm registry is slow and ugly
Please consider following this project's author,
Charlike Mike Reagent, and
If you have any how-to kind of questions, please read the Contributing Guide and Code of Conduct documents. For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.
Project is semantically versioned & automatically released from GitHub Actions with Lerna.
Table of Contents
(TOC generated by verb using markdown-toc)
Install
This project requires Node.js >=10.13 (see
Support & Release Policy).
Install it using yarn or
npm.
We highly recommend to use Yarn when you
think to contribute to this project.
$ yarn add @tunnckocore/package-json
API
Generated using jest-runner-docs.
packageJson
Get package metadata from the Unpkg instead of NPM registry. Optionally you can
pass endpoint
function and return the build the registry url.
Signature
function(packageName, endpoint)
Params
-
packageName
{string} - the package name, supportspkg-name@1.2.2
(version) andpkg-name@next
(dist-tag) -
endpoint
{function} - like(name, tag) => url
-
returns
{object} - package metadata object
Examples
import packageJson from '@tunnckocore/package-json';
async function main() {
console.log(await packageJson('eslint'));
console.log(await packageJson('package-json@4.0.0'));
console.log(await packageJson('ava@next'));
console.log(await packageJson('@babel/core'));
console.log(await packageJson('@tunnckocore/package-json'));
}
main().catch(console.error);
Contributing
Guides and Community
Please read the Contributing Guide and Code of Conduct documents for advices.
For bug reports and feature requests, please join our community forum and open a thread there with prefixing the title of the thread with the name of the project if there's no separate channel for it.
Consider reading the Support and Release Policy guide if you are interested in what are the supported Node.js versions and how we proceed. In short, we support latest two even-numbered Node.js release lines.
Support the project
Become a Partner or Sponsor?
Not financial support? Okey!
Pull requests,
stars and all kind of
contributions
are always welcome.
Contributors
This project follows the all-contributors specification. Contributions of any kind are welcome!
Thanks goes to these wonderful people (emoji key), consider showing your support to them:
Charlike Mike Reagent |
License
Copyright (c) 2018-present, Charlike Mike Reagent
<opensource@tunnckocore.com>
& contributors.
Released under the MPL-2.0 License.