Module:TableTools/Documentation

Ceci est la page de documentation de Module:TableTools [modifier] [purger].

Cette sous-page contient les instructions et les catégories de son module d'origine et elle n'est pas destinée à être visualisée directement.

Utilisation

Ce modèle fournit diverses fonction pour effectuer des opérations courantes sur les tableaux lua. Il est prévu pour un usage par d'autres modules et non pour une invocation directe dans un modèle.

Fonctions exportables

Fonctions d'analyse du contenu / des propriétés du tableau

isPositiveInteger(value) – Prend en argument un nombre et retourne true s'il s'agit d'un entier positif. Cette fonction s'applique à une valeur seule et non à un tableau. Elle est utile pour déterminer si une clé correspond à une clé d'un array (c.-à-d. clé entier positif) ou à une clés de table de hachage (c.-à-d. clé quelconque).
isNan(value) –
length(t) –
size(t) –
isArray(t) –
inArray(arr, valueToFind) –
keysToList(t, keySort, checked) –
numKeys(t) –
affixNums(t, prefix, suffix) –
numData(t, compress) –

Fonctions créant un nouveau tableau

shallowClone(t) –
deepCopy(orig, noMetatable, alreadySeen) –
removeDuplicates(t) –
compressSparseArray(t) –
listToSet(arr) –
invert(t) –
sparseConcat(t, sep, i, j) –

Fonctions d'itération sur un tableau

sparseIpairs(t) –
sortedPairs(t, keySort) –

Modules externes et autres éléments dont ce module a besoin pour fonctionner

mw.ustring.match – Cherche la première correspondance d'un motif dans une chaine de caractères ;

libraryUtil – Bibliothèque de fonctions pour retourner une erreur lorsque le type d'un objet n'est pas celui attendu.

Exemple

Pour utiliser les fonctions de ce module, celui-ci doit être importé avec local TableTools = require('Module:TableTools'). Les fonctions sont ensuite utilisables sous le nom TableTools.nomFonction.

local TableTools = require('Module:TableTools')

local p={}

function p.main(tableau)
    if TableTools.isArray(tableau) then
        return "Le tableau est un array."
    else
        return "Le tableau n'est pas un array."
    end
end

return p

Projet Scribunto