
This package downloads npm packages and extracts their public API.
API & Package Info
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' });
console.log(info.manifest.name);
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/.