brkn
Yet another broken link checker.
Install
$ npm install --save brkn
Usage
const brkn = ; // execute the function; // then listen for the 'end' eventbrknevents;
API
brkn(sources, attributes, baseUrl, [opts])
Emits an end
event (type: Array
) with the inaccessible URLs found in sources
.
Will emit error
event (type: String
) on URL/File parsing errors.
sources
Type: Array
An array with the target web page(s) or file(s).
attributes
Type: Array
An array with the HTML attributes that brkn should scan.
base
Type: String
The hostname (with protocol) to which the relative URLs will resolve to.
options
verbose
Type: Boolean
If true, brkn will emit two additional events:
item
- emitted: after each scanned URL
- type:
Object
- params:
- broken:
Boolean
- source:
String
- statusCode:
Integer
- url:
String
- broken:
source
- emitted: after each completed source, when there are more than one
- type:
Object
- params:
- source:
String
- brokenUrls:
Array
- source:
Related
- brkn-cli - CLI for this module
License
MIT © Gabriel Mangiurea