Design

Key-value mapping

Translate values in JSON to human-readable text using a provided enum key-value map
COMMUNITY FEATURE Available for:
Carbone Cloud
Carbone On-premise
Embedded Carbone JS v2.0+

:convEnum(type)

v0.13.0+

Convert user-defined enums to human readable values

User-defined enums must be passed in options of carbone.render.

Params	Description	Type
type	enum name passed in `options` of `carbone.render(data, options)`	String

Examples

// With API options: {
//   "enum": {
//     "ORDER_STATUS": [
//       "pending",
//       "sent",
//       "delivered"
//     ]
//   }
// }
0:convEnum('ORDER_STATUS') // "pending"
1:convEnum('ORDER_STATUS') // "sent"
5:convEnum('ORDER_STATUS') // 5
// With API options: {
//   "enum": {
//     "YES_NO": {
//       "true": "Yes",
//       "false": "No"
//     }
//   }
// }
false:convEnum('YES_NO') // "No"
true:convEnum('YES_NO') // "Yes"
null:convEnum('YES_NO') // null
3:convEnum('UNKNOWN_ENUM') // 3