lb.base.template.string

Get a closure function that gets values of properties in data.

This method is intended for use in combination with replaceParams(), to get a filter to replace parameters in a string template with values from given data:

var filter = replaceParams( withValuesFrom(data) )

Parameter

{
  section: {
    subsection: {
      name: 'value'
    }
  }
}

Returns

function, a closure wrapped around the given data, with the following signature:

Function: getDataValue(key): any
Get the value of a property, possibly nested, in wrapped data.

Parameter:
  key - string, the key identifying a property, which may be:
          * a string refering to the name of a property: 'name'
          * a dotted string for a nested property: 'section.name'

Returns:
  * any, the value of corresponding property, if found
  * null otherwise

Get a filter function to replace parameters in a string template.

The parameters to replace are surrounded by ‘#’ characters, and allow the folowing characters in the name:

• letters in the ranges a-z and A-Z
• numbers 0-9
• symbols ‘_’ and ‘-’, intended as word separators
• dot character ‘.’ for properties nested in sections and subsections, e.g.  ‘section.subsection.name’ which reference the property at the following location in the data object:

{
  section: {
    subsection: {
      name: 'value'
    }
  }
}

Parameters for which no value is found are left unreplaced.

Parameter

function(name): any

The name argument is the name of the parameter to replace.  The getter value should return string values when a matching property is found, and null otherwise.

Returns

• function, a closure wrapped around the given getter function, with the following signature:

Function: filter(string): string
Replace parameters in given string with values from wrapped getter.

Parameters:
  string - string, the template string with parameters to replace

Returns:
  string, a string computed from the template string by replacing
  named parameters with corresponding values returned by getValue()

• null when the required getter argument is missing or not a function