kotlin-stdlib / kotlin.collections / remove

remove

Common
JVM
JS
Native
1.0
fun <K, V> MutableMap<out K, V>.remove(key: K): V?
(source)

Removes the specified key and its corresponding value from this map.

Return

the previous value associated with the key, or null if the key was not present in the map.

Allows to overcome type-safety restriction of remove that requires to pass a key of type K.

Common
JVM
JS
Native
1.0
fun <T> MutableCollection<out T>.remove(element: T): Boolean
(source)

Removes a single instance of the specified element from this collection, if it is present.

Allows to overcome type-safety restriction of remove that requires to pass an element of type E.

Return true if the element has been successfully removed; false if it was not present in the collection.

Common
JVM
JS
Native
1.0
fun <T> MutableList<T>.remove(index: Int): T
(source)
Deprecated: Use removeAt(index) instead.

Removes the element at the specified index from this list. In Kotlin one should use the MutableList.removeAt function instead.

JVM
JRE8
1.2
fun <K, V> MutableMap<out K, out V>.remove(
    key: K,
    value: V
): Boolean
(source)

Removes the entry for the specified key only if it is currently mapped to the specified value.