Socket
Socket
Sign inDemoInstall

query-registry

Package Overview
Dependencies
17
Maintainers
1
Versions
21
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

query-registry

Query the npm registry for packuments, manifests, packages and download counts


Version published
Maintainers
1
Weekly downloads
16,031
decreased by-6.27%

Weekly downloads

Changelog

Source

[2.6.0] - 2022-08-13

Added

  • Added custom normalization for git urls; the normalized values for the gitRepository property may change with respect to previous releases

Changed

  • Updated dependencies and dev dependencies

Removed

  • Removed dependency on git-url-parse

Readme

Source

query-registry

Build status Coverage jsDocs.io Language npm bundle size npm License

This package exports several functions to query the npm registry (or one of its mirrors) through one of its endpoints.

Features

  • Provides functions to:
    • Get registry metadata
    • Get packuments (package documents) and their abbreviated form
    • Get package manifests
    • Get download counts (packages and registry)
    • Search packages
  • Usable in the browser
  • Fully typed API and response data
  • Supports mirrors of the npm registry
  • Supports caching network requests
  • Well documented and tested

API & Package Info

Install

Using npm:

npm i query-registry

Using yarn:

yarn add query-registry

Usage Examples

Get the metadata for the npm registry:

import { getRegistryMetadata } from 'query-registry';

(async () => {
    const metadata = await getRegistryMetadata();

    // Output: 'registry'
    console.log(metadata.db_name);
})();

Get the latest manifest for package query-registry from the npm registry:

import { getPackageManifest } from 'query-registry';

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

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

Get the abbreviated packument for package query-registry from the npm registry:

import { getAbbreviatedPackument } from 'query-registry';

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

    // Output: 'query-registry'
    console.log(packument.name);
})();

Get the weekly downloads for package query-registry from the npm registry:

import { getPackageDownloads } from 'query-registry';

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

    // Output: 'query-registry'
    console.log(downloads.package);

    // Output: 'number'
    console.log(typeof downloads.downloads);
})();

Get the search results for text query query-registry from the npm registry:

import { searchPackages } from 'query-registry';

(async () => {
    const results = await searchPackages({
        query: { text: 'query-registry' },
    });

    // Output: 'query-registry'
    console.log(results.objects[0].package.name);
})();

Debug

Debug messages are available in non production environments when the DEBUG environment variable is set to query-registry:

DEBUG="query-registry"

For more information, see the debug package.

License

MIT License

Copyright (c) 2021 Edoardo Scibona

See LICENSE file.

Keywords

FAQs

Last updated on 13 Aug 2022

Did you know?

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

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc