pastelsky/bundlephobia

Docs: API surface

Open

#137 opened on Feb 16, 2019

View on GitHub
 (2 comments) (9 reactions) (0 assignees)JavaScript (8,477 stars) (250 forks)batch import
good first issue

Description

hey,

I really love bundlephobia and I use it all the time via by IDE. It brings much-needed focus to the bundle size of dependencies. I'm just wondering if there is an api (there definitely is one I can see it in the request 🙈) that we can/should use? and if so is there any documentation? I could not find any and I'm usually pretty good at finding these informations 🙈

if not then my question directly: "Is there an api where you can get back the size of multiple packages at the same time" e.g. give the size of package A, B, C... I would like to display a list of packages and I don't think doing 20 request at the same time is such a good idea 🙈

so if there is any info available pls let me know. Even if it's just a specific github repo or a code file that's already helpful :)

thxxx :)

Contributor guide

Tech stack
javascriptnodejsrest api
Domain
apidocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
none
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate the bundlephobia source code to identify existing API endpoints, particularly by examining network requests made by the frontend. Look for route definitions in the server code (likely Express.js) to understand the current API surface. Document the endpoints, including the possibility of a batch endpoint for multiple packages. If no batch endpoint exists, consider proposing one. Reference issue #137 and any related discussions in the repo.