Gathering detailed insights and metrics for @jsdocs-io/extractor
Gathering detailed insights and metrics for @jsdocs-io/extractor
The API extractor for npm packages powering jsDocs.io
Installations
npm install @jsdocs-io/extractorDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Min. Node Version
>=20
Node Version
22.15.0
NPM Version
10.9.2
Releases
20
Languages
1
TypeScript
TypeScript (100%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
AGPL-3.0 License
14 Stars
930 Commits
2 Watchers
1 Branches
1 Contributors
Updated on Jul 03, 2025
Maintainers
1
Package Meta Information
Latest Version
1.0.0
Package Id
@jsdocs-io/extractor@1.0.0
Unpacked Size
95.12 kB
Size
24.36 kB
File Count
5
NPM Version
10.9.2
Node Version
22.15.0
Published on
May 21, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
@jsdocs-io/extractor
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
- Explore the API on jsDocs.io
- View package contents on unpkg
- View repository on GitHub
- Read the changelog on GitHub
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
preactpackage from the npm registry:
1import { extractPackageApi } from "@jsdocs-io/extractor"; 2 3(async () => { 4 const packageApi = await extractPackageApi({ pkg: "preact" }); 5 console.log(JSON.stringify(packageApi, null, 2)); 6})();
- Analyze a specific subpath export, like
preact/hooks:
1import { extractPackageApi } from "@jsdocs-io/extractor"; 2 3(async () => { 4 const result = await extractPackageApi({ pkg: "preact", subpath: "hooks" }); 5 console.log(JSON.stringify(packageApi, null, 2)); 6})();
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/.
No vulnerabilities found.
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: GNU Affero General Public License v3.0: LICENSE:0
Reason
Found 0/18 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/dependabot-auto-merge.yml:5
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Warn: no topLevel permission defined: .github/workflows/not-main.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/dependabot-auto-merge.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdocs-io/extractor/dependabot-auto-merge.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdocs-io/extractor/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdocs-io/extractor/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdocs-io/extractor/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdocs-io/extractor/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/not-main.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdocs-io/extractor/not-main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/not-main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdocs-io/extractor/not-main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/not-main.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdocs-io/extractor/not-main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/not-main.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdocs-io/extractor/not-main.yml/main?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 5 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 12 are checked with a SAST tool
Score
4.8
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More