New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

@jsdocs-io/extractor

Package Overview
Dependencies
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@jsdocs-io/extractor

Analyze and extract the API from npm packages

0.4.0
latest
Source
npm
Version published
Weekly downloads
165
126.03%
Maintainers
1
Weekly downloads
 
Created
Source

@jsdocs-io/extractor

Build status Coverage jsDocs.io Language Dependencies npm License

This package downloads npm packages and extracts their public API.

API & Package Info

  • Explore the API on jsDocs.io
  • View package contents on unpkg
  • View repository on GitHub
  • Read the changelog on GitHub

Install

Using npm:

npm i @jsdocs-io/extractor

Using yarn:

yarn add @jsdocs-io/extractor

Usage Example

Analyze the latest version of the query-registry package from the npm registry:

Warning: analyzing packages is a blocking operation that requires some time (even seconds) to finish! Using a worker pool is recommended.

import { analyzeRegistryPackage } from '@jsdocs-io/extractor';

(async () => {
    const info = await analyzeRegistryPackage({ name: 'query-registry' });

    // Output: 'query-registry'
    console.log(info.manifest.name);

    // Output: 'string'
    console.log(typeof info.api?.overview);
})();

Debug

Debug messages are available when the DEBUG environment variable is set to @jsdocs-io/extractor:

DEBUG="@jsdocs-io/extractor"

For more information, see the debug package.

License

AGPL-3.0-or-later

Copyright (C) 2021 Edoardo Scibona

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 15 Aug 2022

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