$file.list

Description

Énumère le contenu d'un dossier. La méthode retourne un tableau d'objets de type file.

Syntaxe

$file.list( directory [ , options ] )

Paramètres

directory file / string

Dossier dont on souhaite énumérer le contenu

options string / map

Filtre des éléments à énumérer ou options. La méthode interprète le paramètre différemment selon son type.

Si le paramètres est un map, la méthode traite la valeur comme un map d'options. Dans ce cas, la méthode reconnait les options suivantes:

filter string / array

Filtre des éléments à énumérer écrit sous la forme d'expression pouvant contenir des wildcards. Il est possible de spécifier plusieurs expressions au sein d'un même string, en utilisant la virgule comme séparateur, p.ex: ".docx,.xlsx".

Les options fileFilter et directoryFilter permettent d'avoir des filtres distincts pour les fichiers et les dossiers. L'option filter est commune aux deux sous-catégories. Ainsi les expressions définies dans filter viennent s'ajouter à celles définies dans fileFilter et directoryFilter.

fileFilter

Filtre appliqué spécifiquement aux fichiers. Les filtres définis dans l'option filter viennent s'ajouter à ceux définis dans fileFilter.

directoryFilter

Filtre appliqué spécifiquement aux dossier. Les filtres définis dans l'option filter viennent s'ajouter à ceux définis dans directoryFilter.

showHidden boolean

Valeur true/false indiquant si les fichiers (ou dossiers) cachés peuvent être repris dans la réponse. L'option est true par défaut.

showLinks boolean

Valeur true/false indiquant si les liens symboliques peuvent être repris dans la réponse. L'option est true par défaut.

ignoreLink boolean

Valeur true/false indiquant si la méthode doit effectuer le traitement dans le cas où directory est lui-même un lien symbolique. Par défaut l'option est false.

Lorsqu'elle est activée et que directory est un lien symbolique, la méthode retourne systématiquement un tableau vide.

Si le paramètre est un string ou un tableau, la méthode considère qu'il s'agit d'un filtre appliqué sur les fichiers et les dossiers (voir option filter ci-dessus).

Retour

Tableau de file

Exemple

Exemple de fonction récursive qui énumère tout le contenu d'un répertoire:

function listContent(dir) {
    for (var file : $file.list(dir)) {
        $logger.info(file);
        if ($file.isDirectory(file)) {
            listContent(file);
        }
    }
}