Deep Dive | Exports

The exports property is an object containing configuration objects used to export the output from templates. This is the top level schema with all possible properties:

{
  "exports": {
    "<export_name>": {
      "name": "",
      "type": "file",
      "destination": "",
      "customData": {}
    }
  }
}

Notes

• Replace <export_name> with any name desired. This name is only used for reference purposes

Table of Contents

• Property Documentation
  • name
  • type
  • destination
  • customData

Property Documentation

name

(string) The human-friendly name of the object. This value is completely arbitrary.

type

(string) The type of export to perform. The following values are supported:

• file Exports the template result to a file. The template configuration must contain the fileName property.

destination

(string) The path, relative to the application's root or an absolute path, to which the output files will be written.

customData

(Object) An object of key/value pairs defining custom data to be made available to the request and template. Each key/value pair will be set to def.vars as def.vars[key] = value.