Document programs: render · StartupBuilder

Reference for Document, one group of Document programs.

Document.render

Render produces a file from a Document in the format the reader asks for. Verb page.

Text

do: return await $.Document.render(input)

Inputs

Input	Type	Required	Description
`document`	Document	required	The Document to render.
`format`	`string`	required	The file format.

Returns

Output	Type	Required	Description
`file`	`url`	required	Where the file lives.
`document`	Document	required	The Document rendered.

Refuses when

Check	Error	Fix	Then call
The input does not match the schema of the operation.	`invalid-input`	Read the schema of the operation, then send every required field with the right type.	None.
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Document.render({ document: 'document_af2wijcmRy', format: 'Example format' })"
  }
}