* @desc Cyan colored console.log * @param args

* @desc Display an crawler option ack * @param f * @param r

* @desc Bright red colored console.log * @param args

* @desc Display an error message and pretty print the exception * @param {string} m - The message to display * @param {Error} error - The except

* @desc Register an eventName, eventListener pairs on an EventEmitter * @param {!EventEmitter} emitter - The EventEmitter to register the eventName

* @desc Blue colored console.log * @param args

* @desc Emit an event * @param {string} event - The event name to be emitted * @param [arg] - The value to be emitted for the event

* @desc Tests (T|F) to see if the execPath is executable by this process * @param {string} execPath - The executable path to test * @returns {Promis

* @desc Get the next URL to crawl from the frontier, queue length - 1 * @return {?string}

* @param {ChromeOptions} options * @return {?ChromeOptions}

* @desc Executes the supplied command * @param {string} someCommand * @param {boolean} [rejectOnError = false] * @returns {Promise<string>}

* @desc Is the frontier exhausted * @return {boolean}

* @desc Navigate to a new Web Page * @param {string} url - The url to navigate the browser to

* @desc Returns the number of URLs left in the queue * @return {number}

* @desc Retrieve the crawl-mode symbol from a configs string * @param {string} mode - The crawl mode * @returns {symbol} - The crawl modes inter

* @desc Red colored console.log * @param args

* @desc Have we seen the supplied URL * @param {string} url - The URL to check if we have seen it * @returns {boolean}

* @desc Disconnect from the Chrome instance currently attached to

* @desc Configures the function that produces the WARC(s) name * @param {CrawlConfig} options

* @desc Initialize the initial frontier * @param {Seed[] | Seed} starting

* @desc Clear all timers * @private

* @desc Clear all timers * @private

* @desc Adds a URL to the set of URLs seen and increments the seeds URL count * @param {string} url - The URL to mark as seen

* * @param {ChromeOptions} options * @param {string} userDataDir * @return {string[]}

* @desc Display message about how the crawl config is broke * @param m * @param config

* @desc Connect to an running instance of Chrome * @param {?ChromeOptions} [options] * @return {Promise<CRI>}

* @desc Are there no more URLs to be crawled that are associated with this seed * @returns {boolean}

* @desc Finds an acceptable Chrome or Chromium executable. * If the env key 'CHROME_PATH' is defined that is returned by default * @returns {Pro

* @desc JS injected into every frame of the page crawled that includes disabling things that can act as an crawler trap, JS that scrolls the page auto

* @desc Green colored console.log * @param args

* @desc Launch Chrome by finding an acceptable executable on the host system * @param {?ChromeOptions} [options = {}] * @return {Promise<CRI>}

* @desc Ensure the starting seed list is one the frontier can understand * @param {Array<{url:string,mode:string,depth:number}|string>|{url:string,

* @desc Process discovered outlinks of a page based on the originating seeds configuration * @param {Array<{href: string, pathname: string, host: s

* @desc Remove the listeners registered on an EventEmitter by either {@link addEventListener} or {@link addEventListeners} * @param {!Array<{emitte

* @desc Determine if a URL should be added to the frontier * @param {Object} url - A URL extracted for the currently visited page * @param {stri

* @desc Stop crawling and exit * @return {Promise<void>}

* @desc Function that returns a promise resolving when chrome tells us the WS endpoint is ready * @param chromeProcess * @param timeout * @return {

* @desc Create a new {@link ChromeCrawler} instance with auto close enabled * @param {CrawlConfig} options - The crawl config for this crawl * @

* @desc Instruct the browsers to inject JavaScript into every page * @return {Promise<void>} * @private

* @desc Returns a function that creates a WARC filename based on the first URL supplied to returned function * @param {string} outPath * @return

* @desc Informs the user that they did not export the correct type of user script * @param {any} exposed

* @desc Informs the user that they did not export the correct type of user script * @param {any} exposed

* @desc Executes the ls command for the supplied path looking for .desktop files for Chrome or Chromium * @param {string} desktopPath * @returns {Pr

* @desc Launches a crawl using the supplied configuration file path * @param {CrawlConfig} conf - The crawl config for this crawl * @return {Promise

* @desc Decreases the number of URLs left to crawl for this seed

* @desc Extracts the Chrome or Chromium executable path from the .desktop file * @param {string} desktopPath * @returns {Promise<string[]>}

* @desc Indicate that the browser has navigated to the current URL

* @desc Enable auto closing of the connection to the remote browser * @return {ChromeCrawler} * @private

* @desc Load the user supplied script (if it exists) and perform validation of it * @param {?string} scriptP - The path to the user script * @re

* @desc Load the user supplied script (if it exists) and perform validation of it * @param {string} scriptP - The path to the user script * @ret

* @desc Normalizes the supplied seeds. If it value of the seeds field is a string loads the seeds from the file * @param {string | string[]} seeds

* @desc Normalizes the supplied seeds. If it value of the seeds field is a string loads the seeds from the file * @param {string | string[]} seeds

* @desc Finds an acceptable Chrome or Chromium executable on MacOS * If one is not found throws * @throws Error - If an acceptable executable wa

* @desc Finds an acceptable Chrome or Chromium executable on Linux * If one is not found throws * @throws Error - If an acceptable executable wa

* @desc Finds an acceptable Chrome or Chromium executable on Windows * If one is not found throws * @throws Error - If an acceptable executable

* @desc Attempts to find an accible target (page) to connect to in an already launched chrome instance * @param {ChromeOptions} options * @return {P

* @desc Called once child frame outlink collection is complete. Collects the top frames outlinks and * resolves the Promise that is being awaited

* @desc Generate the WARC file * @param {!Object} warcInfo - WARC record information * @property {!string} outlinks - Pre-formatted str

* @desc Generate the WARC file * @param {Object} warcInfo - WARC record information * @property {!string} outlinks - Pre-formatted stri

* @desc Receive param object for JS injected into every frame of the page crawled that sets up out link collection * @see https://chromedevtools.gi

* @desc Receive param object for JS injected into every frame of the page crawled that includes disabling things that can act as an crawler trap *

* @desc Retrieve the page's meta information * @return {Promise<{outlinks: string, links: string[], location: string}, Error>}

* @desc Retrieve the page's meta information * @return {Promise<{outlinks: string, links: Array<{href: string, pathname: string, host: string}>, lo

* @desc Collects the outlink information for a frame * @return {{outlinks: string, links: Array<string>, location: string}}

* @desc Retrieve the browsers user-agent string * @return {Promise<string>}

* @desc Retrieve the browsers user-agent string * @return {!Promise<string>}

* @desc Send the `outlinkcollect` message to all child frames and start the collection timeout

* @desc Start monitoring the network and receive a Promise that resolves once network idle occurred or the global wait time has been reached * @par

* @desc Setup the crawler

* @desc Initialize the WARC writter for writting a new WARC * @param {string} warcPath - the path to the new WARC * @param {Object} [o

* @desc Initialize the WARC writter for writting a new WARC * @param {string} warcPath - the path to the new WARC * @param {Object} [o

* * @param {string} confPath * @return {Promise<Object>}

* @desc Indicate that a request has finished for the RequestHandler#navMan * @param {Object} info

* @desc Navigate the browser to the URL of the page to be crawled * @param {string} url * @returns {Promise<boolean>}

* @desc Informs the user that they did not export an async function * @param {any} notAsyncFn

* @desc Informs the user that they did not export an async function * @param {any} notAsyncFn

* @desc Returns a promise that resolves once outlink collection, from top frame and child frames is complete * @return {Promise<{outlinks: string

* @desc Launches a crawl using the supplied configuration file path * @param {CrawlConfig} conf - The crawl config for this crawl * @return {Promise

* @desc Receive the raw function that is used to collect outlines from each of the pages frames. Used by {@link PuppeteerCrawler} * @return {outLin

* @desc Receive the raw scroll page function for use with Runtime.evaluate * @see https://chromedevtools.github.io/devtools-protocol/tot/Runtime#me

* @desc Indicate that a request has finished * @param {Object} info - CDP Response object received by Network.responseReceived or Network.loadingFa

* @desc Indicate that a request was made * @param {Object} info - CDP object received from Network.requestWillBeSent * @see https://chromedevtoo

* @desc Runs a promise using the supplied thener and catcher functions * @param {function()|Promise} runnable The promise or async / promise returnin

* @desc If the user supplied a script that scrip is executed or if non was supplied just scroll the page * @return {Promise<void>}

* @desc Should a discovered URL be added to the frontier using the default strategy, applies for page-only and page-all-links * @param {Object} url

* @desc Should a discovered URL be added to the frontier using the Page Same Domain strategy * @param {Object} url - A URL extracted for the curre

* @desc Determines if the supplied URL is to be ignored or not * @param {string} test - A URL * @return {boolean}

* @desc Setup the necessary listeners

* @desc Start Timers For Navigation Monitoring * @param {string} curl the URL browser is navigating to

* @desc Stop the page loading and stop capturing requests * @return {Promise<void>}

* @desc Returns a function that provides the full path to WARC file being written to * @param {string} outPath the full path to the WARC file outp

* @desc Informs the user that the user script is good

* @desc Informs the user that the user script is good