--

--<S>(source: Array<S>, toRemove: Array<Any>): Array<S>

Removes specified values from an input value.

This version of -- removes all instances of the specified items from an array. Other versions act on objects, strings, and the various date and time formats that are supported by DataWeave.

Name	Description
source	The array containing items to remove.
toRemove	Items to remove from the source array.

Name

Description

source

The array containing items to remove.

toRemove

Items to remove from the source array.

Example

This example removes specified items from an array. Specifically, it removes all instances of the items listed in the array on the right side of -- from the array on the left side of the function, leaving [0] as the result.

Source

%dw 2.0
output application/json
---
{ "a" : [0, 1, 1, 2] -- [1,2] }

Output

{ "a": [0] }

--<K, V>(source: { (K)?: V }, toRemove: Object): { (K)?: V }

Removes specified key-value pairs from an object.

Parameters

Name Description

Name	Description
`source`	The source object (an `Object` type).
`toRemove`	Object that contains the key-value pairs to remove from the source object.

source

The source object (an Object type).

toRemove

Object that contains the key-value pairs to remove from the source object.

Example

This example removes a key-value pair from the source object.

Source

%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- { "hello" : "world"}

Output

{ "name": "DW" }

--(source: Object, keys: Array<String>)

Removes all key-value pairs from the source object that match the specified search key.

Parameters

Name Description

Name	Description
`source`	The source object (an `Object` type).
`toRemove`	An array of keys to specify the key-value pairs to remove from the source object.

source

The source object (an Object type).

toRemove

An array of keys to specify the key-value pairs to remove from the source object.

Example

This example removes two key-value pairs from the source object.

Source

%dw 2.0
output application/json
---
{ "yes" : "no", "good" : "bad", "old" : "new" } -- ["yes", "old"]

Output

{ "good": "bad" }

--(source: Object, keys: Array<Key>)

Removes specified key-value pairs from an object.

Parameters

Name Description

Name	Description
`source`	The source object (an `Object` type).
`keys`	A keys for the key-value pairs to remove from the source object.

source

The source object (an Object type).

keys

A keys for the key-value pairs to remove from the source object.

Example

This example specifies the key-value pair to remove from the source object.

Source

%dw 2.0
output application/json
---
{ "hello" : "world", "name" : "DW" } -- ["hello" as Key]

Output

{ "name": "DW" }

--(source: Null, keys: Any)

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

Introduced in DataWeave version 2.4.0.