helpers

  • function
 

Gets the default helpers and helpers in the documentjs/site/templates folder and registers them with Handlebars.

.build.helpers(buildTemplatesPromise, docMap, options, getCurrent)

Registers helpers

Parameters

  1. buildTemplatesPromise {Promise<Handlebars>}

    The result of calling documentjs.generators.html.build.templates. Building the helpers must happen after the templates have been copied over. Passing this argument enforces that.

  2. docMap {docMap}

    The docMap which contains all docObjects that will be documented.

  3. options {Object}

  4. getCurrent {function()}

    A function that when called, returns the docObject currently being generated.

Returns

{Promise}

A promise that resolves when helpers have been added to Handlebars.