Robustly checks an array of URLs for liveness.
For each URL, it first attempts an HTTP HEAD request, and if that fails it will attempt an HTTP GET request, retrying several times by default with exponential falloff.
This module handles concurrency and retry logic so you can check the status of thousands of links quickly and robustly.
This module requires node >= 14.17.
npm install --save check-links
# or
yarn add check-links
# or
pnpm add check-linksNote: this package uses ESM and no longer provides a CommonJS export. See here for more info on how to use ESM modules.
import checkLinks from 'check-links'
const results = await checkLinks(['https://foo.com', 'https://404.com'])
results['https://foo.com'] // { status: 'alive', statusCode: 200 }
results['https://404.com'] // { status: 'dead', statusCode: 404 }
// example using a custom concurrency, timeout, and retry count
const results2 = await checkLinks(['https://foo.com', 'https://404.com'], {
concurrency: 1,
timeout: { request: 30000 },
retry: { limit: 1 }
})- Supports HTTP and HTTPS urls.
- Defaults to a 30 second timeout per HTTP request with 2 retries.
- Defaults to a Mac OS Chrome
user-agent. - Defaults to following redirects.
- All options use a got options object.
Robustly checks an array of URLs for liveness.
For each URL, it first attempts an HTTP HEAD request, and if that fails it will attempt an HTTP GET request, retrying several times by default with exponential falloff.
Returns a Map<String, LivenessResult> that maps each input URL to an object
containing status and possibly statusCode.
LivenessResult.status will be one of the following:
aliveif the URL is reachable (2XX status code)deadif the URL is not reachableinvalidif the URL was parsed as invalid or used an unsupported protocol
LivenessResult.statusCode will contain an integer HTTP status code if that URL resolved
properly.
Type: function (urls, opts)
urlsarray<string> Array of urls to testoptsobject? Optional configuration options (any extra options are passed to got)opts.concurrencynumber Maximum number of urls to resolve concurrently (optional, default8)
- remark-lint-no-dead-urls - Remark lint plugin that inspired this module.
MIT © Travis Fischer
Support my OSS work by following me on twitter
