Difference between revisions of "Remove"
Jump to navigation
Jump to search
(Created page with "<c>remove</c> removes part of a list, map, or string. See also: indexOf === Arguments === {| class="wikitable" |- ! Parameter Name !! Default Value !! Meaning |- | ''se...") |
m |
||
Line 14: | Line 14: | ||
=== Usage Notes === | === Usage Notes === | ||
Exact behavior of <c>remove</c> depends on the data type of self: | Exact behavior of <c>remove</c> depends on the data type of self: | ||
+ | |||
list: removes one element by its index; the list is mutated in place; | list: removes one element by its index; the list is mutated in place; | ||
− | returns null, and throws an error if the given index out of range | + | returns null, and throws an error if the given index out of range. |
+ | |||
map: removes one key/value pair by key; the map is mutated in place; | map: removes one key/value pair by key; the map is mutated in place; | ||
− | returns 1 if key was found, 0 otherwise string: returns a new string with the first occurrence of k removed | + | returns 1 if key was found, 0 otherwise string: returns a new string with the first occurrence of k removed. |
+ | |||
May be called with function syntax or dot syntax. | May be called with function syntax or dot syntax. | ||
Revision as of 21:54, 2 May 2021
remove
removes part of a list, map, or string.
See also: indexOf
Arguments
Parameter Name | Default Value | Meaning |
---|---|---|
self | list, map, or string | object to remove something from |
Usage Notes
Exact behavior of remove
depends on the data type of self:
list: removes one element by its index; the list is mutated in place; returns null, and throws an error if the given index out of range.
map: removes one key/value pair by key; the map is mutated in place; returns 1 if key was found, 0 otherwise string: returns a new string with the first occurrence of k removed.
May be called with function syntax or dot syntax.
Example
a=["a","b","c"]; a.remove 1 // leaves a == ["a", "c"]
d={"ichi":"one"}; d.remove "ni" // returns 0
"Spam".remove("S") // returns "pam"