Editing Module:TableTools/doc (section)

== inArray ==

<syntaxhighlight lang="lua">TableTools.inArray(array, searchElement)
TableTools.inArray(array, searchElement, fromIndex)</syntaxhighlight>

Returns <code>true</code> if <code>''searchElement''</code> is a member of the array <code>''array''</code>, and <code>false</code> otherwise. Equivalent to the javascript [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes Array.prototype.includes()] function, except fromIndex is 1-indexed instead of zero-indexed.

=== fromIndex ===
<code>fromIndex</code> is the optional 1-based index at which to start searching. If <code>fromIndex</code> 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 <syntaxhighlight lang="lua" inline>pairs()</syntaxhighlight>).

If <code>fromIndex</code> is present and an integer, the array is assumed to be a conventional array/sequence/list (indexed with consecutive integer keys starting at <code>1</code>, and interated over using <syntaxhighlight lang="lua" inline>ipairs()</syntaxhighlight>). Only the values whose index is <code>fromIndex</code> or higher will be searched.

In the following examples, <code>#array</code> represents the length of the integer-keyed portion of the array.

* If <code>fromIndex < 0</code> it will count back from the end of the array, e.g. a value of <code>-1</code> will only search the last integer-keyed element in the array. If <code>fromIndex <= (-1 * #array)</code>, the entire integer-keyed portion of the array will be searched.
* If <code>fromIndex = 0</code> it will be treated as a <code>1</code> and the entire integer-keyed portion of the array will be searched.
* If <code>fromIndex > #array</code>, the array is not searched and <code>false</code> is returned.