From fe7812bab807c7761e29f83a4a29090a2a02a415 Mon Sep 17 00:00:00 2001 From: Edoardo Scibona <12040076+velut@users.noreply.github.com> Date: Sat, 13 Apr 2024 01:28:28 +0200 Subject: [PATCH] docs: add links to types --- src/get-abbreviated-packument.ts | 2 ++ src/get-registry-metadata.ts | 2 ++ src/get-registry-signing-keys.ts | 2 ++ 3 files changed, 6 insertions(+) diff --git a/src/get-abbreviated-packument.ts b/src/get-abbreviated-packument.ts index e7ca3f0..970b459 100644 --- a/src/get-abbreviated-packument.ts +++ b/src/get-abbreviated-packument.ts @@ -69,6 +69,8 @@ To get all the metadata (full packument) about a package see {@link getPackument @param name - package name @param registry - URL of the registry (default: npm registry) + +@see {@link AbbreviatedPackument} */ export const getAbbreviatedPackument = async ( name: string, diff --git a/src/get-registry-metadata.ts b/src/get-registry-metadata.ts index aa2a5ad..332f8b6 100644 --- a/src/get-registry-metadata.ts +++ b/src/get-registry-metadata.ts @@ -38,6 +38,8 @@ export type RegistryMetadata = z.infer; `getRegistryMetadata` returns the metadata describing the registry itself. @param registry - URL of the registry (default: npm registry) + +@see {@link RegistryMetadata} */ export const getRegistryMetadata = async (registry = npmRegistryUrl): Promise => fetchData(RegistryMetadata, registry); diff --git a/src/get-registry-signing-keys.ts b/src/get-registry-signing-keys.ts index 2fa26e2..5050853 100644 --- a/src/get-registry-signing-keys.ts +++ b/src/get-registry-signing-keys.ts @@ -38,6 +38,8 @@ export type RegistrySigningKeys = z.infer; `getRegistrySigningKeys` returns the public signing keys used by the registry. @param registry - URL of the registry (default: npm registry) + +@see {@link RegistrySigningKeys} */ export const getRegistrySigningKeys = async ( registry = npmRegistryUrl,