bit-docs-generate-html/build/helpers module

Gets the default helpers, and helpers in the bit-docs-generate-html/site/templates/buildHash folder, and registers them with Handlebars.

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

Registers helpers

Parameters

  1. buildTemplatesPromise {Promise<Handlebars>}:

    The result of calling bit-docs-generate-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.