docs: add links to types

velut · Apr 12, 2024 · fe7812b · fe7812b
1 parent 03d19c5
commit fe7812b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git 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
@@ -38,6 +38,8 @@ 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 const getRegistryMetadata = async (registry = npmRegistryUrl): Promise<RegistryMetadata> =>
 	fetchData(RegistryMetadata, registry);
diff --git a/src/get-registry-signing-keys.ts b/src/get-registry-signing-keys.ts
@@ -38,6 +38,8 @@ export type RegistrySigningKeys = z.infer<typeof RegistrySigningKeys>;
 `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,