Transformer Pipeline Module API Reference (JavaScript)  7.1.10.30066-248dcbc
Format Module: Pipeline Functions

Detailed Description

The format module if loaded exposes some methods to pipelines to enable formatting of strings.

Note
The methods in this package are only available if the format module is loaded.

Functions

 formatter.format (var formatString, var textToFormat)
 Format a string according to the specified format parameter. More...
 
 formatter.validate (var formatString)
 Validate a format string. More...
 

Function Documentation

formatter.format ( var  formatString,
var  textToFormat 
)

Format a string according to the specified format parameter.

Parameters
formatString- Format specification to apply
textToFormat- The text that should be formatted
Returns
Formatted text
Note
The format specifiers are defined within the Transformer SDK documentation
formatter.validate ( var  formatString)

Validate a format string.

Parameters
formatString- Format string to validate
Return values
0- Format is valid
-1- Format is invalid
Note
The format specifiers are defined within the Transformer SDK documentation

Generated on Mon Aug 24 2020 15:30:29 for Transformer Pipeline Module API Reference (JavaScript)