query-registry/dist/get-registry-metadata.d.ts

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

import * as z from "zod";
export declare const RegistryMetadata: z.ZodObject<{
    db_name: z.ZodOptional<z.ZodString>;
    doc_count: z.ZodOptional<z.ZodNumber>;
    doc_del_count: z.ZodOptional<z.ZodNumber>;
    update_seq: z.ZodOptional<z.ZodNumber>;
    purge_seq: z.ZodOptional<z.ZodNumber>;
    compact_running: z.ZodOptional<z.ZodBoolean>;
    disk_size: z.ZodOptional<z.ZodNumber>;
    data_size: z.ZodOptional<z.ZodNumber>;
    instance_start_time: z.ZodOptional<z.ZodString>;
    disk_format_version: z.ZodOptional<z.ZodNumber>;
    committed_update_seq: z.ZodOptional<z.ZodNumber>;
    compacted_seq: z.ZodOptional<z.ZodNumber>;
    uuid: z.ZodOptional<z.ZodString>;
    other: z.ZodOptional<z.ZodObject<{
        data_size: z.ZodOptional<z.ZodNumber>;
    }, z.core.$strip>>;
    sizes: z.ZodOptional<z.ZodObject<{
        file: z.ZodOptional<z.ZodNumber>;
        active: z.ZodOptional<z.ZodNumber>;
        external: z.ZodOptional<z.ZodNumber>;
    }, z.core.$strip>>;
}, z.core.$strip>;
/**
`RegistryMetadata` describes the metadata describing the registry itself.
@see {@link https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#registry}
@see {@link https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get}
@see {@link https://docs.couchdb.org/en/stable/api/database/common.html}
*/
export type RegistryMetadata = z.infer<typeof RegistryMetadata>;
/**
`getRegistryMetadata` returns the metadata describing the registry itself.

@param registry - URL of the registry (default: npm registry)

@see {@link RegistryMetadata}
*/
export declare function getRegistryMetadata(registry?: string): Promise<RegistryMetadata>;