## CurlyBracketParser CurlyBracketParser Parse variables with curly brackets within templates/strings or files Use filters for special cases * [CurlyBracketParser](#CurlyBracketParser) * [.getVersion()](#CurlyBracketParser.getVersion) → string * [.parse(string, variables, options)](#CurlyBracketParser.parse) → string * [.parseFile(path, variables, options)](#CurlyBracketParser.parseFile) → string \| null * [.parseFileWrite(path, variables, options)](#CurlyBracketParser.parseFileWrite) → string \| null * [.registerFilter(name, filter_function, options)](#CurlyBracketParser.registerFilter) * [.processFilter(name, value)](#CurlyBracketParser.processFilter) → string * [.validFilters()](#CurlyBracketParser.validFilters) → Array.<string> * [.isValidFilter(name)](#CurlyBracketParser.isValidFilter) → boolean * [.registerDefaultVar(name, var_function, options)](#CurlyBracketParser.registerDefaultVar) → function * [.processDefaultVar(name)](#CurlyBracketParser.processDefaultVar) → string * [.unregisterDefaultVar(name)](#CurlyBracketParser.unregisterDefaultVar) → boolean * [.registeredDefaultVars()](#CurlyBracketParser.registeredDefaultVars) → Array.<string> * [.isRegisteredDefaultVar(name)](#CurlyBracketParser.isRegisteredDefaultVar) → boolean * [.decodeVariable(variable)](#CurlyBracketParser.decodeVariable) → Object * [.decodedVariables(string)](#CurlyBracketParser.decodedVariables) → Array.<Object> * [.variables(string)](#CurlyBracketParser.variables) → Array.<string> * [.isAnyVariableIncluded(string)](#CurlyBracketParser.isAnyVariableIncluded) → boolean * [.includesOneVariableOf(variable_names, string)](#CurlyBracketParser.includesOneVariableOf) → boolean ### CurlyBracketParser.getVersion() → string Get the version of the used library ### CurlyBracketParser.parse(string, variables, options) → string Parse given string and replace the included variables by the given variables. Given variable values of type null, undefined, NaN or Infinity are processed as empty strings. **Returns**: string - parsed string | Param | Type | Description | | --- | --- | --- | | string | string | | | variables | Object.<string, string> | value> | | options | Object | | | options.unresolved_vars | 'throw' \| 'keep' \| 'replace' | 'throw', 'keep', 'replace' => define how to act when unresolved variables within the string are found. | | options.replace_pattern | string | pattern used when param unresolved_vars is set to 'replace'. You can include the var name $1 and filter $2. Empty string to remove unresolved variables. | ### CurlyBracketParser.parseFile(path, variables, options) → string \| null Parse given path content and replace the included variables by the given variables **Returns**: string \| null - parsed string. In case of given 'success' parameter, the success() function will be called as callback and this function will return null instead. | Param | Type | Description | | --- | --- | --- | | path | string | to file to parse | | variables | Object.<string, string> | value> | | options | Object | | | options.unresolved_vars | 'throw' \| 'keep' \| 'replace' | 'throw', 'keep', 'replace' => define how to act when unresolved variables within the string are found. | | options.replace_pattern | string | pattern used when param unresolved_vars is set to 'replace'. You can include the var name $1 and filter $2. Empty string to remove unresolved variables. | | options.success | function | only affects when running inside a browser. If given, the file of the given path will be requested asynchronous and the parsed string will be passed to this function. | | options.write | boolean | write parsed content of the file directly into the file. Only available when running by node js. | ### CurlyBracketParser.parseFileWrite(path, variables, options) → string \| null Parse given path content and replace the included variables by the given variables Alias method of .parseFile with option write: true Only available when running on node js (not in browser) **Returns**: string \| null - parsed string. In case of given 'success' parameter, the success() function will be called as callback and this function will return null instead. | Param | Type | Description | | --- | --- | --- | | path | string | to file to parse | | variables | Object.<string, string> | value> | | options | Object | | | options.unresolved_vars | 'throw' \| 'keep' \| 'replace' | 'throw', 'keep', 'replace' => define how to act when unresolved variables within the string are found. | | options.replace_pattern | string | pattern used when param unresolved_vars is set to 'replace'. You can include the var name $1 and filter $2. Empty string to remove unresolved variables. | ### CurlyBracketParser.registerFilter(name, filter_function, options) Register your custom filter to the filter list **Throws**: - FilterAlreadyRegisteredError if filter does already exist | Param | Type | Description | | --- | --- | --- | | name | string | | | filter_function | function | | | options | Object | | | options.raise_on_exist | boolean | raise exception if filter does already exist, default: true | ### CurlyBracketParser.processFilter(name, value) → string Process the given value with the given filter **Returns**: string - converted string with applied filter **Throws**: - InvalidFilterError if the given filter name is invalid | Param | Type | Description | | --- | --- | --- | | name | string | of the filter to apply on the value, e.g. {{var_name|my_filter_name}} | | value | string | string to apply the specified filter on | ### CurlyBracketParser.validFilters() → Array.<string> Retrieve array with valid filters ### CurlyBracketParser.isValidFilter(name) → boolean Check if a given filter is valid **Returns**: boolean - true if filter exists, otherwise false | Param | Type | | --- | --- | | name | string | ### CurlyBracketParser.registerDefaultVar(name, var_function, options) → function Register a default variable to be replaced automatically by the given block value in future If the variable exists already, it will throw an VariableAlreadyRegisteredError **Returns**: function - var_function | Param | Type | Description | | --- | --- | --- | | name | string | of the default var | | var_function | function | function returning the variable value | | options | Object | | | options.overwrite | boolean | explicitly overwrite an existing default var without throwing an execption | ### CurlyBracketParser.processDefaultVar(name) → string Return the given default variable by returning the result of its function **Returns**: string - the result of the given default variable function | Param | Type | | --- | --- | | name | string | ### CurlyBracketParser.unregisterDefaultVar(name) → boolean Unregister / remove an existing default variable **Returns**: boolean - true if variable existed and was unregistered, false if it didn't exist | Param | Type | Description | | --- | --- | --- | | name | string | of the variable | ### CurlyBracketParser.registeredDefaultVars() → Array.<string> Return an array of registered default variables ### CurlyBracketParser.isRegisteredDefaultVar(name) → boolean Check if the given variable is a registered default variable **Returns**: boolean - true if variable is registered, otherwise false | Param | Type | Description | | --- | --- | --- | | name | string | of the variable | ### CurlyBracketParser.decodeVariable(variable) → Object Return a object containing separated name and filter of a variable **Returns**: Object - name, filter | Param | Type | Description | | --- | --- | --- | | variable | string | string to scan | **Example** ```js # '{{var_name|filter_name}}' => { name: 'var_name', filter: 'filter_name' } ``` ### CurlyBracketParser.decodedVariables(string) → Array.<Object> Scans the given url for variables with pattern '{{var|optional_filter}}' **Returns**: Array.<Object> - array of variable names and its filters | Param | Type | Description | | --- | --- | --- | | string | string | to scan | **Example** ```js # 'The variable {{my_var|my_filter}} is inside this string' => [{ name: "my_var", filter: "my_filter"}] ``` ### CurlyBracketParser.variables(string) → Array.<string> Scans the given url for variables with pattern '{{var|optional_filter}}' **Returns**: Array.<string> - array of variable names and its filters | Param | Type | Description | | --- | --- | --- | | string | string | to scan | ### CurlyBracketParser.isAnyVariableIncluded(string) → boolean Check if any variable is included in the given string **Returns**: boolean - true if any variable is included in the given string, otherwise false | Param | Type | Description | | --- | --- | --- | | string | string | name of variable to check for | ### CurlyBracketParser.includesOneVariableOf(variable_names, string) → boolean Check if one of the given variable names is included in the given string **Returns**: boolean - true if one given variable name is included in given the string, otherwise false | Param | Type | Description | | --- | --- | --- | | variable_names | | | | string | string | name of variable to check for |