Repository files navigation

This is the API extractor poweringjsDocs.io.

It downloads packages from the npm registry and analyzes them to extract their public API.

• Bun must be installed to resolve and install packages

• Explore the API onjsDocs.io
• View package contents onunpkg
• View repository onGitHub
• Read the changelog onGitHub

1. Analyze the latest version of thepreact package from the npm registry:

import{extractPackageApi}from"@jsdocs-io/extractor";(async()=>{constpackageApi=awaitextractPackageApi({pkg:"preact"});console.log(JSON.stringify(packageApi,null,2));})();

2. Analyze a specificsubpath export, likepreact/hooks:

import{extractPackageApi}from"@jsdocs-io/extractor";(async()=>{constresult=awaitextractPackageApi({pkg:"preact",subpath:"hooks"});console.log(JSON.stringify(packageApi,null,2));})();

AGPL-3.0-or-later

Copyright (C) 2025 Edoardo Scibona. SeeLICENSE.

This program is free software: you can redistribute it and/or modifyit under the terms of the GNU Affero General Public License as published bythe Free Software Foundation, either version 3 of the License, or(at your option) any later version.

This program is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public Licensealong with this program. If not, seehttps://www.gnu.org/licenses/.