Module:table/documentation

This module provides functions for dealing with Lua tables. All of them, except for two helper functions, take a table as their first argument.

Some functions are available as methods in the arrays created by Module:array.

Functions by what they do:

• Create a new table:
  • shallowCopy, deepCopy, removeDuplicates, numKeys, compressSparseArray, keysToList, reverse, invert, listToSet
• Create an array:
  • removeDuplicates, numKeys, compressSparseArray, keysToList, reverse
• Return information about the table:
  • size, length, contains, keyFor, isArray, deepEquals
• Treat the table as an array (that is, operate on the values in the array portion of the table: values indexed by consecutive integers starting at 1):
  • removeDuplicates, length, contains, serialCommaJoin, reverseIpairs, reverse, invert, listToSet, isArray
• Treat a table as a sparse array (that is, operate on values indexed by non-consecutive integers):
  • numKeys, maxIndex, compressSparseArray, sparseConcat, sparseIpairs
• Generate an iterator:
  • sparseIpairs, sortedPairs, reverseIpairs
• Other:
  • sparseConcat, serialCommaJoin, reverseConcat

The original version was a copy of Module:TableTools on Wikipedia via Module:TableTools on Commons, but new functions have been added since then.

Detailed documentation

(The generated documentation is located at the module page.)