package cascade

  1. Overview
  2. Docs
package cascade
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module BrowserSource

Locating the node and the headless browser the render harnesses and the CLI's browser comparison drive, and reporting their absence the same way.

Sourceval getenv : string -> string option

getenv name is the value of the environment variable name, and None when it is unset or empty.

Sourceval executable : string -> bool

executable path is true when path names a file this process may execute.

Sourceval chrome_binary : unit -> string option

chrome_binary () is a headless-capable Chromium: CHROME when that names an executable, then PATH, then the puppeteer and playwright caches, then the macOS application bundle. Each cache keeps one directory per version, so the largest path is the newest build.

Sourceval node_binary : unit -> string option

node_binary () is node: NODE when that names an executable, PATH otherwise.

Sourceval chrome_version : string -> (int * int) option

chrome_version chrome is the (major, minor) the binary reports. The support dataset is keyed by version, so a harness that looks a production up has to say which build it measured rather than assume the one the default contract names.

Sourceval skip : string -> string -> 'a

skip harness reason prints a skip line naming harness and exits with status 0, so a machine without a browser does not fail the suite.

Sourceval suppressed : string -> unit

suppressed harness exits when CASCADE_NO_BROWSER is set: status 0 for the one value that acknowledges the run checks nothing, and status 1 for any other, so silencing harness cannot read as a pass.