aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Table.remove.3
blob: bec0a1a2d94272a871c88acff292c7f864bb75dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Table.remove 3 2025-04-30 "Tomo man-pages"
.SH NAME
Table.remove \- remove a table entry
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Table.remove\ :\ func(t:\ {K=V},\ key:\ K\ ->\ Void)
.fi
.SH DESCRIPTION
Removes the key-value pair associated with a specified key.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
t	{K=V}	The reference to the table. 	-
key	K	The key of the key-value pair to remove. 	-
.TE
.SH RETURN
Nothing.

.SH EXAMPLES
.EX
t := {"A"=1, "B"=2}
t.remove("A")
>> t
= {"B"=2}
.EE