Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gajus/deadlink
Find dead URLs and fragment identifiers.
https://github.com/gajus/deadlink
Last synced: about 2 months ago
JSON representation
Find dead URLs and fragment identifiers.
- Host: GitHub
- URL: https://github.com/gajus/deadlink
- Owner: gajus
- License: other
- Created: 2014-10-31T08:34:26.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-06-12T03:02:25.000Z (over 7 years ago)
- Last Synced: 2024-10-05T13:47:51.087Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 383 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - gajus/deadlink - Find dead URLs and fragment identifiers. (others)
README
Deadlink
[](https://travis-ci.org/gajus/deadlink)
[](https://www.npmjs.org/package/deadlink)
Find dead URLs and fragment identifiers (URLs with a hash and a corresponding ID element in the resulting document).
Deadlink is using a combination of header inspection, [data inspection](https://github.com/mscdex/mmmagic) (2015-08-06: mmmagic has been temporary removed until issues with iojs 3.0.0 are resolved) and content length inspection to determine if the content exists, when to listen for the response, and when to [bail out](#special-case).
Deadlink is using [jsdom](https://github.com/tmpvar/jsdom) to load the document and execute it. Therefore, resolving fragment identifiers will work even if the element IDs of the resulting document are generated dynamically after `DOMContentLoaded` event.
Contents
* [Deadlink](#deadlink)
* [Contents](#contents)
* [Usage](#usage)
* [Resolving URLs and Fragment Identifiers](#usage-resolving-urls-and-fragment-identifiers)
* [Resolving URLs](#usage-resolving-urls)
* [Resolving Fragment Identifiers](#usage-resolving-fragment-identifiers)
* [Deadlink.Resolution](#usage-deadlink-resolution)
* [Matching URLs](#usage-matching-urls)
* [Download](#download)
Usage
This guide explains the most common use case, without going into details about the properties of the intermediate results. Some of these properties are useful for further analyzes, such as knowing when to load the document to extract the IDs for fragment identification.
Refer to the [test cases](https://github.com/gajus/deadlink/tree/master/tests) for the detail explanation of Deadlink behavior.
```js
var Deadlink = require('deadlink'),
deadlink = Deadlink();
```
Resolving URLs and Fragment Identifiers
This is a convenience wrapper to resolve a collection of URLs, including the fragment identifier when it is part of the URL. URL/Fragment Identifier is resolved with a promise that in turn resolves to [`Deadlink.Resolution`](#deadlinkresolution).
```js
var promises = deadlink.resolve([
'http://gajus.com/foo',
'http://gajus.com/bar',
'http://gajus.com/#foo',
'http://gajus.com/#bar'
]);
```
Use [`Promise.all`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/all) to construct a promise that resolves when all of the promises in the collection are resolved. [`Deadlink.Resolution`](#deadlinkresolution) of a successful resolution does not have an `error` property.
```js
Promise.all(promises).then(function () {
promises.forEach(function (Resolution) {
if (!Resolution.error) {
// OK
}
});
});
```
Resolving URLs
The same as [`deadlink.resolve()`](#resolving-urls-and-fragment-identifiers) but limited to URL resolution.
```js
deadlink.resolveURLs([
'http://gajus.com/foo',
'http://gajus.com/bar'
]);
```
Special Case
There is one special case when promise for a valid response can be rejected.
It is rejected if `Content-Type` is `text/html` and content length is larger than 5MB. Deadlink is storing the response of `text/html` in case `resolveFragmentIdentifierURL` will be referring to the said URL in future. If you foresee this as an issue, [raise an issue](https://github.com/gajus/deadlink/issues) stating your use case.
Resolving Fragment Identifiers
The same as [`deadlink.resolve()`](#resolving-urls-and-fragment-identifiers) but limited to Fragment Identifier resolution.
```js
deadlink.resolveFragmentIdentifierURLs([
'http://gajus.com/#foo',
'http://gajus.com/#bar'
]);
```
Deadlink.Resolution
The resolution object reflects the type of the resource:
```js
Deadlink.URLResolution
Deadlink.FragmentIdentifierDocumentResolution
Deadlink.FragmentIdentifierURLResolution
```
All of these objects extend from `Deadlink.Resolution`.
The [test cases](https://github.com/gajus/deadlink/tree/master/tests) explain what properties and when do each of these objects have.
Matching URLs
`deadlink.matchURLs(inputString)` collects all URLs from a string. This function is a wrapper around [URL RegExp](https://github.com/gajus/url-regexp) `match()`.
Download
Download using [NPM](https://www.npmjs.org/):
```sh
npm install deadlink
```