Define DataWeave Functions
|
DataWeave 2.2 is compatible and bundled with Mule 4.2. This version of Mule reached its End of Life on May 2, 2023, when Extended Support ended. Deployments of new applications to CloudHub that use this version of Mule are no longer allowed. Only in-place updates to applications are permitted. MuleSoft recommends that you upgrade to the latest version of Mule 4 that is in Standard Support so that your applications run with the latest fixes and security enhancements. |
You can define your own DataWeave functions using the fun declaration in the header of a DataWeave script.
Before you begin, note that DataWeave version 2 is for Mule 4 apps. For a Mule 3 app,
refer to the
DataWeave 1.0 documentation set
in the Mule 3.9 documentation. For other Mule versions, you can use
the version selector for the Mule Runtime table of contents.
In this simple example, a DataWeave function accepts a single String argument that outputs "HELLO":
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("hello")The argument to a DataWeave function can be any DataWeave expression. This function also outputs "HELLO":
%dw 2.0
output application/json
fun toUpper(aString) = upper(aString)
---
toUpper("h" ++ "el" ++ lower("LO") )To test the type of the argument passed into your function, you can perform pattern matching with the built-in match operation.
%dw 2.0
output application/json
fun toUpper(aString)
= aString match {
case is String -> upper(aString)
else -> null
}
---
toUpper("h" ++ "el" ++ lower("LO") )This example creates a function that reformats a numeric string into a common phone number format:
%dw 2.0
output application/json
fun toPhoneFormat(str: String) =
"(" ++ str[0 to 2] ++ ") " ++ str[3 to 5] ++ "-" ++ str[6 to 9]
---
toPhoneFormat("1234567890")"(123) 456-7890"