sizeOf

sizeOf(array: Array<Any>): Number

Returns the number of elements in an array. It returns 0 if the array is empty.

This version of sizeOf takes an array or an array of arrays as input. Other versions act on arrays of objects, strings, or binary values.

Parameters

Name Description

Name	Description
`array`	The input array. The elements in the array can be any supported type.

array

The input array. The elements in the array can be any supported type.

Example

This example counts the number of elements in the input array. It returns 3.

Source

%dw 2.0
output application/json
---
sizeOf([ "a", "b", "c"])

Output

Example

This example returns a count of elements in the input array.

Source

%dw 2.0
output application/json
---
{
  "arraySizes": {
     size3: sizeOf([1,2,3]),
     size2: sizeOf([[1,2,3],[4]]),
     size0: sizeOf([])
   }
}

Output

{
   "arraySizes": {
     "size3": 3,
     "size2": 2,
     "size0": 0
   }
}

sizeOf(object: Object): Number

Returns the number of key-value pairs in an object.

This function accepts an array of objects. Returns 0 if the input object is empty.

Parameters

Name Description

Name	Description
`object`	The input object that contains one or more key-value pairs.

object

The input object that contains one or more key-value pairs.

Example

This example counts the key-value pairs in the input object, so it returns 2.

Source

%dw 2.0
output application/json
---
sizeOf({a: 1, b: 2})

Output

Example

This example counts the key-value pairs in an object.

Source

%dw 2.0
output application/json
---
{
   objectSizes : {
     sizeIs2: sizeOf({a:1,b:2}),
     sizeIs0: sizeOf({})
   }
}

Output

{
  "objectSize": {
    "sizeIs2": 2,
    "sizeIs0": 0
  }
}

sizeOf(binary: Binary): Number

Returns the size of a binary payload in bytes. Returns 0 if the payload is empty.

Parameters

Name Description

Name	Description
`binary`	The input array of binary values.

binary

The input array of binary values.

Example

This example returns the number of bytes in the binary payload. Notice how multi-byte UTF-8 characters take up more than one byte.

Source

%dw 2.0
output application/json
---
{

BinarySizeOf: sizeOf("'my word'" as Binary) ++ " " ++ sizeOf("'my word'" as Binary),

StringSizeOf: sizeOf("'my word'") ++ " " ++ sizeOf("'my word'")

}

Output

{

"BinarySizeOf": "9 9",

"StringSizeOf": "9 9"

}

sizeOf(text: String): Number

Returns the number of characters (including white space) in an string.

Returns 0 if the string is empty.

Parameters

Name Description

Name	Description
`text`	The input text.

text

The input text.

Example

This example returns the number of characters in the input string "abc".

Source

%dw 2.0
output application/json
---
sizeOf("abc")

Output

Example

This example returns the number of characters in the input strings. Notice it counts blank spaces in the string "my string" and that sizeOf("123" as Number) returns 1 because 123 is coerced into a number, so it is not a string.

Source

%dw 2.0
output application/json
---
{
  sizeOfSting2 : sizeOf("my string"),
  sizeOfEmptyString: sizeOf(""),
  sizeOfNumber : sizeOf("123" as Number)
}

Output

{
  "sizeOfSting2": 9,
  "sizeOfEmptyString": 0,
  "sizeOfNumber": 1
}

sizeOf(n: Null): Null

Helper function that enables sizeOf to work with a null value.

Introduced in DataWeave version 2.4.0.