1 | import { RegistryMetadata } from '../types/registry-metadata';
|
2 | /**
|
3 | * `getRegistryMetadata` returns the metadata describing the registry itself.
|
4 | *
|
5 | * @param registry - URL of the registry (default: npm registry)
|
6 | * @param cached - accept cached responses (default: `true`)
|
7 | *
|
8 | * @example
|
9 | * Get the metadata for the npm registry:
|
10 | *
|
11 | * ```typescript
|
12 | * import { getRegistryMetadata } from 'query-registry';
|
13 | *
|
14 | * (async () => {
|
15 | * const metadata = await getRegistryMetadata();
|
16 | *
|
17 | * // Output: 'registry'
|
18 | * console.log(metadata.db_name);
|
19 | * })();
|
20 | * ```
|
21 | *
|
22 | * @example
|
23 | * Get the metadata for a custom registry:
|
24 | *
|
25 | * ```typescript
|
26 | * import { getRegistryMetadata } from 'query-registry';
|
27 | *
|
28 | * (async () => {
|
29 | * const metadata = await getRegistryMetadata({ registry: 'https://example.com' });
|
30 | * })();
|
31 | * ```
|
32 | *
|
33 | * @see {@link RegistryMetadata}
|
34 | * @see {@link npmRegistry}
|
35 | */
|
36 | export declare function getRegistryMetadata({ registry, cached, }?: {
|
37 | registry?: string;
|
38 | cached?: boolean;
|
39 | }): Promise<RegistryMetadata>;
|
40 | //# sourceMappingURL=get-registry-metadata.d.ts.map |
\ | No newline at end of file |