Function

Static Public Summary
public	cmdconfig(): *
public	cmdrun(): *
public	cmdversion(): *
public	createConfigFile(fileName: String): Boolean Generates stub configuration file inside configuration folder
public	createConfigStub(): Object Creates stub configuration file with default params
public	createConfigsDir() Creates configuration directory inside process.cwd() folder
public	run(options: Object) Runs application from cli interface

Static Public

import cmdconfig from 'bs-broken-links-checker/src/cli/cmd-config.es6'

import cmdrun from 'bs-broken-links-checker/src/cli/cmd-run.es6'

import cmdversion from 'bs-broken-links-checker/src/cli/cmd-version.es6'

import {createConfigFile} from 'bs-broken-links-checker/src/acts/config.es6'

Generates stub configuration file inside configuration folder

Name	Type	Attribute	Description
fileName	String		name of file

returns true if success, false otherwise

import {createConfigStub} from 'bs-broken-links-checker/src/acts/config.es6'

Creates stub configuration file with default params

stub config object

import {createConfigsDir} from 'bs-broken-links-checker/src/acts/config.es6'

Creates configuration directory inside process.cwd() folder

import {run} from 'bs-broken-links-checker/src/acts/run.es6'

Runs application from cli interface

Name	Type	Attribute	Description
options	Object	optional	configuration object
options.mode	String	optional	mode of checking ("website", "section" or "page")
options.concurrent	Number	optional	number of concurrent requests
options.requestRetriesAmount	Number	optional	number of attempts for request if it fails at first
options.requestTimeout	Number	optional	request timeout (in milliseconds)
options.checkExternalUrls	Boolean	optional	set `true` for check outer links