Interface BundleSize

Bundle size information for a specific package version.

Returned by GET /api/size?package={name}@{version}.

Example

const size = await client.package('react').size('18.2.0');
console.log(size.gzip); // 2670
interface BundleSize {
    assets: BundleAsset[];
    dependencyCount: number;
    dependencySizes: DependencySize[];
    description: string;
    gzip: number;
    hasJSModule: boolean;
    hasJSNext: boolean;
    hasSideEffects: boolean | "unknown";
    isModuleType: boolean;
    name: string;
    scoped: boolean;
    size: number;
    version: string;
}

Properties

assets dependencyCount dependencySizes description gzip hasJSModule hasJSNext hasSideEffects isModuleType name scoped size version

Properties

assets

assets: BundleAsset[]

Individual assets that make up the bundle

dependencyCount

dependencyCount: number

Number of transitive dependencies included in the bundle

dependencySizes

dependencySizes: DependencySize[]

Per-dependency size breakdown

description

description: string

Package description from package.json

gzip

gzip: number

Gzip-compressed size in bytes

hasJSModule

hasJSModule: boolean

Whether the package exports an ES module via the module field

hasJSNext

hasJSNext: boolean

Whether the package exports an ES module via the jsnext:main field

hasSideEffects

hasSideEffects: boolean | "unknown"

Whether the package is known to have side effects

isModuleType

isModuleType: boolean

Whether the package.json declares "type": "module"

name

name: string

Package name

scoped

scoped: boolean

Whether the package name is scoped (e.g. @scope/pkg)

size

size: number

Minified size in bytes

version

version: string

Resolved version

Settings

Member Visibility

On This Page

Properties