import BrokenLinkChecker from 'broken-link-checker-local/src/BrokenLinkChecker.js'
Constructor Summary
Public Constructor | ||
public |
constructor(argv: Array<string>) Creates a new BrokenLinkChecker with the specified options. |
Member Summary
Public Members | ||
public |
The instance of express.Application used. |
|
public get |
The base url to use when serving files. |
|
public |
|
|
public |
The parsed command line options used. |
|
public |
The path to check. |
|
public |
The server used. |
|
public |
The URL to check. |
Private Members | ||
private |
The arguments to handle. |
Method Summary
Public Methods | ||
public |
Exits BrokenLinkChecker with the specified exit code and (optionally) an error that occurred. |
|
public |
Sets either BrokenLinkChecker#path or BrokenLinkChecker#path from the first non-option argument provided. |
|
public |
launch(): * Launches the CLI. |
|
public |
runChecker(port: number): Promise<number> Runs |
|
public |
startServer(port: number): Promise<number, Error> Starts a server serving BrokenLinkChecker#path on the speficied port. |
|
public |
Validates options. |
Public Constructors
Public Members
Private Members
Public Methods
public exit(code: number, err: Error): number source
Exits BrokenLinkChecker with the specified exit code and (optionally) an error that occurred.
Test:
public getPathOrUrl() source
Sets either BrokenLinkChecker#path or BrokenLinkChecker#path from the first non-option argument provided.
public runChecker(port: number): Promise<number> source
Runs blc
on the given port or BrokenLinkChecker#url.
Params:
Name | Type | Attribute | Description |
port | number |
|
The port to check. |
public startServer(port: number): Promise<number, Error> source
Starts a server serving BrokenLinkChecker#path on the speficied port.
Params:
Name | Type | Attribute | Description |
port | number | The port to server on. |