bpm/values
Documentation
- source: bpm/values.ts
Overview
Classes
Values
parseValue()
Attempts to parse a value as a JSON string. If the value is a valid JSON string (representing an object or array), it is parsed and returned as an object. If parsing fails (e.g., the value is a primitive or an invalid JSON string), the original value is returned.
tsstatic parseValue(value: any): any;
Parameter Type Description valueanyThe value to parse, typically a string read from the API. Returns
- Type:
any- Description: The parsed object, or the original value if parsing fails.
parseValuesMap()
Iterates over the values of a Map and applies #parseValue(any) to each value. This is typically used to deserialize all variables returned from an API call.
tsstatic parseValuesMap(variables: Map): Map;
Parameter Type Description variablesMapThe Map of variable names to their values (which may be JSON strings). Returns
- Type:
Map- Description: The Map with all values deserialized where possible.
stringifyValue()
Serializes a value for persistence or API transfer. Arrays and objects are converted into their respective JSON string representations. Note: Arrays are additionally converted into a `java.util.List` of stringified elements for Java API compatibility. Primitive types are returned as is.
tsstatic stringifyValue(value: any): any;
Parameter Type Description valueanyThe value to serialize. Returns
- Type:
any- Description: The JSON string representation, a Java List (for arrays), or the original primitive value.
stringifyValuesMap()
Iterates over the values of a Map and applies #stringifyValue(any) to each value. This is typically used to serialize a map of variables before sending them to an API call.
tsstatic stringifyValuesMap(variables: Map): Map;
Parameter Type Description variablesMapThe Map of variable names to their values. Returns
- Type:
Map- Description: The Map with all values serialized.
