Import: collection/maps

The collection/maps import provides helpers for working with maps.

get

get(object, path[, default])

Get the value from the provided object using the path. When the path is invalid or the object doesn't contain a value at the path, then the default is returned. The default return value is undefined.

Arguments

Examples

Get a value from a simple object:

Press "Run" to get policy output

Get a nested value from a complex object:

Press "Run" to get policy output

Get a list of values using splat:

Press "Run" to get policy output

Get an invalid path, providing a default:

Press "Run" to get policy output

Get an invalid path, not providing a default:

Press "Run" to get policy output

has

has(object, path)

Return a boolean value if the object has the path within its structure.

Arguments

Examples

An object has a valid key:

Press "Run" to get policy output

An object does not have a valid key:

Press "Run" to get policy output

omit

omit(object, paths)

Return a map, removing each path from the paths provided from the source object. The original structure of the map is maintained, as seen in the below examples.

Arguments

Examples

Omitting a single value:

Press "Run" to get policy output

Omitting multiple values:

Press "Run" to get policy output

Omitting deep values:

Press "Run" to get policy output

pick

pick(object, paths)

Return a map consisting of each value found in object from the paths provided. The original structure of the map is maintained, as seen in the below examples.

Arguments

Examples

Picking a single value:

Press "Run" to get policy output

Picking multiple values:

Press "Run" to get policy output

Picking deep values:

Press "Run" to get policy output

set

set(object, path, value)

Return a new map, assigning the provided value to the provided path. It will not modify the provided map in place.

Arguments

Examples

Set a value on a simple path:

Press "Run" to get policy output

Set a value on a deep path:

Press "Run" to get policy output

Set a value on an index in a list:

Press "Run" to get policy output

Set a value on every key within a list key:

Press "Run" to get policy output

unset

unset(object, path)

Return a new map, removing the provided path from the source object. It will not modify the provided map in place.

Arguments

Examples

Unset on a simple path:

Press "Run" to get policy output

Unset on a deep path:

Press "Run" to get policy output

Unset an index in a list:

Press "Run" to get policy output

Unset a list:

Press "Run" to get policy output

Paths

Map helpers often receive a path argument that allows for looking up a nested key. Generally speaking, a path is a series of keys separated by ., however there are some additional capabilites that need to be explained.

Lists

When traversing a nested map that contains a list, a specific index can be retrieved by providing the index as the part of the path.

In the following code sample, the path will first enter the key "foo" within the map, followed by entering the first index of the list.

path = "foo.0"
object = {"foo": [1]}

Splat

To provide advanced capabilities when using paths, you can also use the splat (*) operator to iterate through all elements in a list, with all parts of the path following the splat occuring on each entry.

In the following code sample, the path will first enter the key "foo" within the map. It will then enter each item in the list, entering the "bar" key for each nested object.

path = "foo.*.bar"
object = {"foo": [{"bar": 1}, {"bar": 2}]}