diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2024-12-31 15:46:53 -0500 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2024-12-31 15:46:53 -0500 |
| commit | 156d54a73e005eecbb9a4284b74994313a34e4aa (patch) | |
| tree | b54f5574213df750d2b7292a088172f43b9f86a5 /docs | |
| parent | 4b11f1b2b63effe71ddac5aac0879c1512057e8b (diff) | |
Add array:pop()
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/arrays.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/arrays.md b/docs/arrays.md index 76372cb9..3bb15bdf 100644 --- a/docs/arrays.md +++ b/docs/arrays.md @@ -608,6 +608,44 @@ arr:insert_all([99, 100], at=2) --- +### `pop` + +**Description:** +Removes and returns an item from the array. If the given index is present in +the array, the item at that index will be removed and the array will become one +element shorter. + +**Signature:** +```tomo +func pop(arr: &[T], index: Int = -1 -> T?) +``` + +**Parameters:** + +- `arr`: The array to remove an item from. +- `index`: The index from which to remove the item (default: the last item). + +**Returns:** +`none` if the array is empty or the given index does not exist in the array, +otherwise the item at the given index. + +**Example:** +```tomo +>> arr := [10, 20, 30, 40] + +>> arr:pop() += 40 +>> arr += &[10, 20, 30] + +>> arr:pop(index=2) += 20 +>> arr += &[10, 30] +``` + +--- + ### `random` **Description:** |
