Interface ZcapSpecExamplesCliOptions

interface ZcapSpecExamplesCliOptions {
    help?: boolean;
    url?: string;
    baseUrl?: string;
    format?: ZcapSpecExamplesOutputFormat;
}

Properties

help?: boolean

Print help text and exit instead of doing anything else.

url?: string

URL to fetch zcap-spec HTML from. Ignored if stdin is piped.

baseUrl?: string

Base URL used to build absolute example urls. Defaults to the URL that was fetched; set this explicitly to get absolute URLs out of stdin input.

Output format.

"ndjson" -- one compact object per line. The default here, and what a pipeline should see.
"json" -- the same objects, indented. Readable by eye; still a valid stream of JSON values for jq.
"text" -- a human-readable listing.

The CLI picks between "json" and "ndjson" based on whether stdout is a terminal; see NodejsZcapSpecExamplesCli.