## Module Overview

The `lang.map` module corresponds to the `mapping` basic type.


Applies a function each member of a map and returns a map of the result.

The resulting map will have the same keys as the argument map.



'map

Type

func

Type1

new map containing result of applying parameter `func` to each member


Returns a map containing [key, member] pair as the value for each key.



entries

Selects the members from a map for which a function returns true.



filter

a predicate to apply to each element to test whether it should be included


boolean

new map containing members for which parameter `func` evaluates to true


Applies a function to each member of a map.

The parameter `func` is applied to each member of parameter `m`.



forEach

Returns the member of a map with given key.

This for use in a case where it is known that the map has a specific key,
and accordingly panics if parameter `m` does not have a member with parameter `k` key.



string

error

Tests whether a map value has a member with a given key.



hasKey

true if parameter `m` has a member with key parameter `k`


Returns an iterator over a map.

The iterator will iterate over the members of the map not the keys.
The function `entries` can be used to iterate over the keys and members together.
The function `keys` can be used to iterator over just the keys.



iterator

a new iterator object that will iterate over the members of parameter `m`


object {
    public isolated function next() returns record {|
        Type value;
    |}?;
} 

Returns a list of all the keys of a map.



keys

length

Combines the members of a map using a combining function.

The combining function takes the combined value so far and a member of the map,
and returns a new combined value.



reduce

initial value for the first argument of combining parameter `func`


initial

result of combining the members of parameter `m` using parameter `func`


Removes a member of a map.

This removes the member of parameter `m` with key parameter `k` and returns it.
It panics if there is no such member.



remove

the member of parameter `m` that had key parameter `k`


Removes all members of a map.

This panics if any member cannot be removed.



removeAll

Removes a member of a map with a given key, if the map has member with the key.

If parameter `m` has a member with key parameter `k`, it removes and returns it;
otherwise it returns `()`.



removeIfHasKey

the member of parameter `m` that had key parameter `k`, or `()` if parameter `m` does not have a key parameter `k`


Returns a list of all the members of a map.



toArray

an array whose members are the members of parameter `m`


The `lang.map` module corresponds to the `mapping` basic type.


A type parameter that is a subtype of `any|error`.
Has the special semantic that when used in a declaration
all uses in the declaration must refer to same type.


ballerina/lang.map : 0.0.0

Module Overview

Functions

Types

Type	A type parameter that is a subtype of `any\|error`.
Type1	A type parameter that is a subtype of `any\|error`.