This module includes a number of functions for dealing with Lua tables. It is a meta-module, meant to be called from other Lua modules, and should not be called directly from #invoke.
To use any of the functions, first you must load the module.
Returns true if ''value'' is a positive integer, and false if not. Although it doesn't operate on tables, it is included here as it is useful for determining whether a given table key is in the array part or the hash part of a table.
Returns true if ''value'' is a NaN value, and false if not. Although it doesn't operate on tables, it is included here as it is useful for determining whether a value can be a valid table key. (Lua will generate an error if a NaN value is used as a table key.)
Returns a clone of a table. The value returned is a new table, but all subtables and functions are shared. Metamethods are respected, but the returned table will have no metatable of its own. If you want to make a new table with no shared subtables and with metatables transferred, you can use [[mw:Extension:Scribunto/Lua reference manual#mw.clone|mw.clone]] instead. If you want to make a new table with no shared subtables and without metatables transferred, use [[#deepCopy|deepCopy]] with the noMetatable option.
Removes duplicate values from an array. This function is only designed to work with standard arrays: keys that are not positive integers are ignored, as are all values after the first nil value. (For arrays containing nil values, you can use [[#compressSparseArray|compressSparseArray]] first.) The function tries to preserve the order of the array: the earliest non-unique value is kept, and all subsequent duplicate values are removed. For example, for the table removeDuplicates will return .
Takes a table ''t'' and returns an array containing the numbers of any positive integer keys that have non-nil values, sorted in numerical order. For example, for the table, numKeys will return .
Takes a table ''t'' and returns an array containing the numbers of keys with the optional prefix ''prefix'' and the optional suffix ''suffix''. For example, for the table and the prefix 'a', affixNums will return . All characters in ''prefix'' and ''suffix'' are interpreted literally.
Given a table with keys like "foo1", "bar1", "foo2", and "baz2", returns a table of subtables in the format . Keys that don't end with an integer are stored in a subtable named "other". The compress option compresses the table so that it can be iterated over with ipairs.
Takes an array ''t'' with one or more nil values, and removes the nil values while preserving the order, so that the array can be safely traversed with ipairs. Any keys that are not positive integers are removed. For example, for the table, compressSparseArray will return .
This is an iterator function for traversing a sparse array ''t''. It is similar to [[mw:Extension:Scribunto/Lua reference manual#ipairs|ipairs]], but will continue to iterate until the highest numerical key, whereas ipairs may stop after the first nil value. Any keys that are not positive integers are ignored.
Usually sparseIpairs is used in a generic for loop.
Note that sparseIpairs uses the [[mw:Extension:Scribunto/Lua reference manual#pairs|pairs]] function in its implementation. Although some table keys appear to be ignored, all table keys are accessed when it is run.
Finds the size of a key/value pair table (associative array). For example, for, size will return 2. The function will also work on arrays, but for arrays it is more efficient to use the # operator. Note that to find the size, this function uses the [[mw:Extension:Scribunto/Lua reference manual#pairs|pairs]] function to iterate through all of the keys.
Returns a list of the keys in a table, sorted using either a default comparison function or a custom ''keySort'' function, which follows the same rules as the comp function supplied to [[mw:Extension:Scribunto/Lua reference manual#table.sort|table.sort]]. If ''keySort'' is false, no sorting is done. Set ''checked'' to true to skip the internal type checking.
Iterates through a table, with the keys sorted using the keysToList function. If there are only numerical keys, sparseIpairs is probably more efficient.
Returns true if ''value'' is a table and all keys are consecutive integers starting at 1.
Returns true if ''value'' is iterable and all keys are consecutive integers starting at 1.
Transposes the keys and values in an array. For example, yields .
Creates a set from the array part of the table ''arr''. Indexing the set by any of the values of the array returns true. For example, yields .
Creates a copy of the table ''orig''. As with mw.clone, all values that are not functions are duplicated and the identity of tables is preserved. If ''noMetatable'' is true, then the metatable (if any) is not copied. Can copy tables loaded with mw.loadData.
Similar to mw.clone, but mw.clone cannot copy tables loaded with mw.loadData and does not allow metatables not to be copied.
Concatenates all values in the table that are indexed by a positive integer, in order. For example, yields and yields .
Finds the length of an array or of a quasi-array with keys with an optional ''prefix'' such as "data1", "data2", etc. It uses an exponential search algorithm to find the length, so as to use as few table lookups as possible.
This algorithm is useful for arrays that use metatables (e.g. frame.args) and for quasi-arrays. For normal arrays, just use the
Returns true if ''searchElement'' is a member of the array ''array'', and false otherwise. Equivalent to the javascript Array.prototype.includes function, except fromIndex is 1-indexed instead of zero-indexed.
fromIndex is the optional 1-based index at which to start searching. If fromIndex is not present, all values in the array will be searched and the array will be treated as a table/associative array (it will be iterated over using
If fromIndex is present and an integer, the array is assumed to be a conventional array/sequence/list (indexed with consecutive integer keys starting at 1, and interated over using fromIndex or higher will be searched.
In the following examples, #array represents the length of the integer-keyed portion of the array.
fromIndex < 0 it will count back from the end of the array, e.g. a value of -1 will only search the last integer-keyed element in the array. If fromIndex <= (-1 * #array), the entire integer-keyed portion of the array will be searched.fromIndex = 0 it will be treated as a 1 and the entire integer-keyed portion of the array will be searched.fromIndex > #array, the array is not searched and false is returned.Given the arrays, returns an array containing the elements of each input array in sequence.
Extends the first array in place by appending all elements from the second array.