🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

@jsdocs-io/extractor

Package Overview
Dependencies
Maintainers
1
Versions
21
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@jsdocs-io/extractor

The API extractor for npm packages powering jsdocs.io

1.0.0
latest
Source
npm
Version published
Weekly downloads
80
-20%
Maintainers
1
Weekly downloads
 
Created
Source

@jsdocs-io/extractor

Build status Coverage jsDocs.io Language npm License

This is the API extractor powering jsDocs.io.

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

Requirements

  • Bun must be installed to resolve and install packages

API & Package Info

Usage Examples

[!WARNING] Analyzing packages is a blocking operation that requires some time, even seconds, to finish! Using workers is recommended.

  • Analyze the latest version of the preact package from the npm registry:
import { extractPackageApi } from "@jsdocs-io/extractor";

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

(async () => {
	const result = await extractPackageApi({ pkg: "preact", subpath: "hooks" });
	console.log(JSON.stringify(packageApi, null, 2));
})();

License

AGPL-3.0-or-later

Copyright (C) 2025 Edoardo Scibona. See LICENSE.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the 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 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

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

Keywords

npm

FAQs

Package last updated on 21 May 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts