Home Manual Reference Source Test

Variable

Static Public Summary
public

Command line options available

Static Public

public CliOptions: Object source 

import CliOptions from 'broken-link-checker-local/src/cliOptions.js'

Command line options available

Properties:

NameTypeAttributeDescription
exclude yargs.Option<String[]>
  • optional
  • default: []

A keyword/glob to match links against. Can be used multiple times.
exclude-external yargs.Option<Boolean>
  • optional
  • default: false

Will not check external links.
exclude-internal yargs.Option<Boolean>
  • optional
  • default: false

Will not check internal links.
filter-level yargs.Option<Number>
  • optional
  • default: 1

The types of tags and attributes that are considered links.
follow yargs.Option<Boolean>
  • optional
  • default: false

Force-follow robot exclusions.
get yargs.Option<Boolean>
  • optional
  • default: false

Change request method to GET.
recursive yargs.Option<Boolean>
  • optional
  • default: false

Recursively scan "crawl" the HTML document(s).
user-agent yargs.Option<String>
  • optional

The user agent to use for link checks.
verbose yargs.Option<Boolean>
  • optional
  • default: false

Display excluded links.