`$zip.create`¶

Description¶

Crée une archive zip avec les fichiers passés en paramètre.

Syntaxe¶

$zip.create( zip , files [ , options ] )

Paramètres¶

zip file / string

Fichier zip à créer ou compléter

files file / string / array

Fichier(s) à ajouter dans l'archive. Le ou les fichiers peuvent être un path donné sous forme de string, une référence de file, un tableau de file ou de string représentant des paths.

Il est possible de référencer un dossier, auquel cas tout le contenu du dossier est repris dans l'archive.

options map

Map d'options. Les options reconnues sont:

basePath file / string

Dossier de référence. Les paths de fichiers et de dossiers au sein de l'archive zip seront construits relativement au basePath si celui-ci est spécifié.

En l'absence de basePath, les fichiers sont systématiquement ajoutés à la racine du zip. La construction du zip générera une erreur si dans ce cas on cherche à ajouter deux fichiers de même nom.

L'option attend un path de dossier. Toutefois il est autorisé de passer un path de fichier, auquel cas la méthode s'appuiera sur le dossier parent du fichier en question.

Retour¶

Retourne le fichier zip généré sous forme de file ou null en cas d'erreur.

Exemple¶

$zip.create(
    "c:/Temp/test.zip",
    [ "c:/Temp/TestImage.png",
      "c:/Temp/test médical.png",
      "c:/Temp/README.md",
      "c:/Temp/test/README.md" ],
    { basePath: "C:/Temp" }
);

Dans l'exemple ci-dessus on ajoute deux fichiers "README.md" dans l'archive. L'option basePath est importante ici pour que l'arborescence soit reprise dans l'archive. Si on omet cette option, la construction du zip échouera avec l'erreur suivante:

C:\opt\ewt\test\scripts\_test.script:6:7 - duplicate entry: README.md

$zip.create¶