vnfmarket/src/main/webapp/vnfmarket/node_modules/handlebars/docs/decorators-api.md

   1 # Decorators
   2
   3 Decorators allow for blocks to be annotated with metadata or wrapped in functionality prior to execution of the block. This may be used to communicate with the containing helper or to setup a particular state in the system prior to running the block.
   4
   5 Decorators are registered through similar methods as helpers, `registerDecorators` and `unregisterDecorators`. These can then be referenced via the friendly name in the template using the `{{* decorator}}` and `{{#* decorator}}{/decorator}}` syntaxes. These syntaxes are derivatives of the normal mustache syntax and as such have all of the same argument and whitespace behaviors.
   6
   7 Decorators are executed when the block program is instantiated and are passed `(program, props, container, context, data, blockParams, depths)`.
   8
   9 - `program`: The block to wrap
  10 - `props`: Object used to set metadata on the final function. Any values set on this object will be set on the function, regardless of if the original function is replaced or not. Metadata should be applied using this object as values applied to `program` may be masked by subsequent decorators that may wrap `program`.
  11 - `container`: The current runtime container
  12 - `context`: The current context. Since the decorator is run before the block that contains it, this is the parent context.
  13 - `data`: The current `@data` values
  14 - `blockParams`: The current block parameters stack
  15 - `depths`: The current context stack
  16
  17 Decorators may set values on `props` or return a modified function that wraps `program` in particular behaviors. If the decorator returns nothing, then `program` is left unaltered.
  18
  19 The [inline partial](https://github.com/wycats/handlebars.js/blob/master/lib/handlebars/decorators/inline.js) implementation provides an example of decorators being used for both metadata and wrapping behaviors.