Skip to main content

Function: writeOpenCliDocument()

writeOpenCliDocument(document, output?, format?): Promise<void>

Render document (JSON, YAML, or Markdown) and write it to output, or to stdout if output is omitted. Shared by every framework package's docgen command and by handleOpenCliRequest.

Parameters​

document​

OpenCliDocument

output?​

string

format?​

DocumentFormat = 'json'

Returns​

Promise<void>