pkg-size
    TypeScript icon, indicating that this package has built-in type declarations

    2.4.0 • Public • Published






    Measure the size of your npm package distribution

    ⚡️ Try it in your npm package

    $ npx pkg-size

    If you like this project, please star it & follow me to see what other cool projects I'm working on! ❤️

    🙋‍♂️ Why?

    • 🔍 Size analysis Quickly determine the total size of what you're publishing to npm!
    • 🔥 Same behavior as npm pack/publish Collects publish files as specified in your package.json!
    • 🙌 Gzip & Brotli See how your files compress in addition to normal size!
    • 🤖 Node.js API Integrate size checks to your CI via Node.js API

    🚀 Install

    npm i pkg-size

    🚦 Quick Usage

    const pkgSize = require('pkg-size');
    
    // Get package size data from current working directory
    const sizeData = await pkgSize();
    
    // Get package size data from a specific package path
    const sizeData = await pkgSize('/path/to/package');

    ⚙️ API

    type FileEntry = {
        path: string;
        mode: number;
        size: number;
        sizeGzip: number;
        sizeBrotli: number;
    };
    
    type PkgSizeData = {
        pkgPath: string;
        tarballSize: number;
        files: FileEntry[];
    };
    
    function pkgSize(pkgPath?: string): Promise<PkgSizeData>;

    Install

    npm i pkg-size

    DownloadsWeekly Downloads

    32

    Version

    2.4.0

    License

    MIT

    Unpacked Size

    174 kB

    Total Files

    12

    Last publish

    Collaborators

    • hirokiosame