docObject

  • function
 

Writes out a docObject.

.write.docObject(docObject, renderer, options, setCurrentDocObjectForHelpers)

Parameters

  1. docObject {docObject}

    The doc object to be written out.

  2. renderer {renderer(docObject)}

    A function that renders the output.

  3. options {Object}

    Configuration options.

    • dest {String}

      The folder name this file will be written to. The filename is determined from the docObject's name.

  4. setCurrentDocObjectForHelpers {function(documentjs.process.docObject)}

Returns

{Promise}

A promise that resolves when the file has been written out.