mrdocs::createFrame

Create child data objects.

Synopsis

Declared in <mrdocs/Support/Handlebars.hpp>

dom::Object
createFrame(dom::Object const& parent);

Description

This function can be used by block helpers to create child data objects.

The child data object is an overlay frame object implementation that will first look for a value in the child object and if not found will look in the parent object.

Helpers that modify the data state should create a new frame object when doing so, to isolate themselves and avoid corrupting the state of any parents.

Generally, only one frame needs to be created per helper execution. For example, the each iterator creates a single frame which is reused for all child execution.

Return Value

The overlay object

Parameters

Name Description

parent

The underlying frame object

See Also

https://mustache.github.io/mustache.5.html#Sections

Created with MrDocs