Class BundlephobiaClient

Main entry point for the Bundlephobia API client.

Example

import { BundlephobiaClient } from 'bundlephobia-api-client';

const client = new BundlephobiaClient();

// Get bundle size for the latest version
const size = await client.package('react');

// Get bundle size for a specific version
const size18 = await client.package('react').size('18.2.0');

// Get size history across all versions
const history = await client.package('react').history();

// Get similar/alternative packages
const similar = await client.package('react').similar();

Constructors

constructor

Methods

on package

Constructors

constructor

Methods

on

  • on<K extends "request">(event: K, callback: BundlephobiaClientEvents[K]): this

    Subscribes to a client event.

    Type Parameters

    • K extends "request"

    Parameters

    Returns this

    Example

    client.on('request', (event) => {
      console.log(`${event.method} ${event.url} — ${event.durationMs}ms`);
      if (event.error) console.error('Request failed:', event.error);
    });

package

  • package(name: string): PackageResource

    Returns a PackageResource for a given package name, providing access to bundle size, version history, and similar packages.

    The returned resource can be awaited directly to fetch the bundle size for the latest version, or chained to access specific methods.

    Parameters

    • name: string

      The package name (e.g. 'react', '@types/node')

    Returns PackageResource

    A chainable package resource

    Example

    const size    = await client.package('react');
    const size18  = await client.package('react').size('18.2.0');
    const history = await client.package('react').history();
    const similar = await client.package('react').similar();

Settings

Member Visibility

On This Page

Constructors
Methods