Package Exports
- package-build-stats
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (package-build-stats) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
This is the function that powers the core of building, minifying and gzipping of packages in bundlephobia.
Usage
const getBuiltPackageStats = require('package-build-stats');
getBuiltPackageStats('packageName', { options })
.then((result) => console.log(result))Options
| Option | Values | Description |
|---|---|---|
| client | 'npm' or 'yarn' |
Which client to use to install package for building |
| limitConcurrency | true or false |
When using yarn as the client, use the network mutex to limit concurrency |
| networkConcurrency | number |
When using yarn as client, limit simultaneous installs to this number. |
| customImports | Array<string> |
By default, the default export is used for calculating sizes. Setting this option allows calculation of package stats based on more granular top-level exports. |
Testing results using in-built server in development
Commands
To start an local server that builds packages, run -
yarn run startThe server runs at port 3000.
Making requests
To build a package and get it's stats, run a curl request like so -
curl 'localhost:3000/size?p=<package-name>'eg.
curl 'localhost:3000/size?p=react'Contributing
Clone the repo, npm install, and run the server.
The file you're probably looking for is getPackageStats.js