check-links
Version:
Robustly checks an array of URLs for liveness.
89 lines (58 loc) • 3.88 kB
Markdown
> Robustly checks an array of URLs for liveness.
[](https://www.npmjs.com/package/check-links) [](https://github.com/transitive-bullshit/check-links/actions/workflows/test.yml) [](https://prettier.io)
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 >= 18`.
```bash
npm install --save check-links
yarn add check-links
pnpm add check-links
```
Note: this package uses ESM and no longer provides a CommonJS export. See [here](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) for more info on how to use ESM modules.
```js
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](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md).
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
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:
- `alive` if the URL is reachable (2XX status code)
- `dead` if the URL is not reachable
- `invalid` if 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)`
- `urls` **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** Array of urls to test
- `opts` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Optional configuration options (any extra options are passed to [got](https://github.com/sindresorhus/got#options))
- `opts.concurrency` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum number of urls to resolve concurrently (optional, default `8`)
- [remark-lint-no-dead-urls](https://github.com/davidtheclark/remark-lint-no-dead-urls) - Remark lint plugin that inspired this module.
MIT © [Travis Fischer](https://github.com/transitive-bullshit)
Support my OSS work by <a href="https://twitter.com/transitive_bs">following me on twitter <img src="https://storage.googleapis.com/saasify-assets/twitter-logo.svg" alt="twitter" height="24px" align="center"></a>