hcl/ext/userfunc/doc.go
Martin Atkins 26f1e48014 ext/userfunc: extension for user-defined functions
This package provides helper function that looks in a given body for
blocks that define functions, returning a function map suitable for use
in a zcl.EvalContext.
2017-07-25 18:34:56 -07:00

23 lines
848 B
Go

// Package userfunc implements a zcl extension that allows user-defined
// functions in zcl configuration.
//
// Using this extension requires some integration effort on the part of the
// calling application, to pass any declared functions into a zcl evaluation
// context after processing.
//
// The function declaration syntax looks like this:
//
// function "foo" {
// params = ["name"]
// result = "Hello, ${name}!"
// }
//
// When a user-defined function is called, the expression given for the "result"
// attribute is evaluated in an isolated evaluation context that defines variables
// named after the given parameter names.
//
// The block name "function" may be overridden by the calling application, if
// that default name conflicts with an existing block or attribute name in
// the application.
package userfunc