types.Table.clear

Method on every table

clear(): any

Removes every key/value pair from the table, in place.

examples/types/table/clear-basic.nut

let squad = {healer = 1, tank = 1}
squad.clear()
println("squad.len() =", squad.len())

Output:

squad.len() = 0

Return value

The table itself, now empty.

Errors

Throws Cannot modify immutable object when the table was frozen with freeze().

Notes

Takes no arguments. Existing references to the table see it become empty too, since clear mutates the same object rather than building a new one - unlike constructor(), which returns an unrelated new table.

Example

examples/types/table/clear.nut

let t = {a=1, b=2}
let alias = t          // same table, not a copy
let r = t.clear()
println("t.len() =", t.len())
println("r == t:", r == t)          // clear returns the table itself
println("alias.len() =", alias.len())     // the alias sees the same empty table

let frozen = freeze({a=1})
try {
  frozen.clear()
} catch (e) {
  println("frozen.clear() throws:", e)
}