check url

src/cli/index.ts

@@ -4,7 +4,7 @@ import pkginfo from "pkginfo";
 import updateNotifier from "update-notifier";
 import pkg from "../../package.json";
 import { getAllRegistryPackuments } from "../io/all-packuments-io";
-import { makeCheckUrlExists } from "../io/check-url";
+import { checkUrlExists } from "../io/check-url";
 import { searchRegistry } from "../io/npm-search";
 import { findNpmrcPath, loadNpmrc, saveNpmrc } from "../io/npmrc-io";
 import { getRegistryPackument } from "../io/packument-io";
@@ -54,8 +54,6 @@ import {
 
 const log = npmlog;
 
-const checkUrlExists = makeCheckUrlExists();
-
 const loadRegistryAuth = makeLoadRegistryAuth(loadUpmConfig);
 const parseEnv = makeParseEnv(
   log,

src/io/check-url.ts

@@ -8,11 +8,17 @@ import fetch from "node-fetch";
 export type CheckUrlExists = (url: string) => Promise<boolean>;
 
 /**
- * Makes a {@link CheckUrlExists} function.
+ * Makes a {@link CheckUrlExists} function that determines whether a url
+ * exists by checking whether it responds to a HEAD request with 200.
  */
-export function makeCheckUrlExists(): CheckUrlExists {
+export function CheckUrlIsOk(): CheckUrlExists {
   return async (url) => {
     const response = await fetch(url, { method: "HEAD" });
     return response.status === 200;
   };
 }
+
+/**
+ * Default {@link CheckUrlExists} function. Uses {@link CheckUrlIsOk}.
+ */
+export const checkUrlExists: CheckUrlExists = CheckUrlIsOk();

test/io/check-url.test.ts

@@ -1,21 +1,21 @@
-import { makeCheckUrlExists } from "../../src/io/check-url";
 import fetch, { Response } from "node-fetch";
+import { CheckUrlIsOk } from "../../src/io/check-url";
 
 jest.mock("node-fetch");
 
-describe("check url exists", () => {
+describe("check url is ok", () => {
   function makeDependencies() {
-    const checkUrlExists = makeCheckUrlExists();
-    return { checkUrlExists } as const;
+    const checkUrlIsOk = CheckUrlIsOk();
+    return { checkUrlIsOk } as const;
   }
 
   it("should be true if url responds with 200", async () => {
     jest.mocked(fetch).mockResolvedValue({
       status: 200,
     } as Response);
-    const { checkUrlExists } = makeDependencies();
+    const { checkUrlIsOk } = makeDependencies();
 
-    const actual = await checkUrlExists("https://some.url.com");
+    const actual = await checkUrlIsOk("https://some.url.com");
 
     expect(actual).toBeTruthy();
   });
@@ -26,9 +26,9 @@ describe("check url exists", () => {
       jest.mocked(fetch).mockResolvedValue({
         status: statusCode,
       } as Response);
-      const { checkUrlExists } = makeDependencies();
+      const { checkUrlIsOk } = makeDependencies();
 
-      const actual = await checkUrlExists("https://some.url.com");
+      const actual = await checkUrlIsOk("https://some.url.com");
 
       expect(actual).toBeFalsy();
     }