$yenc.encode
¶
Description¶
Encode un fichier en yEnc
Syntaxe¶
$yenc.encode( source [ , options ] )
Paramètres¶
source
file / string- Fichier à encoder. Peut être passé sous forme d'objet
file
ou de path (enstring
). options
map-
Map d'option à prendre en considération pour l'encodage. Les options reconnues sont:
dest
file / string- Fichier de destination. La valeur peut être soit un
objet
file
, soit une chaîne de caractères désignant un path. charset
string- Si ce paramètre est défini, la méthode retournera la valeur encodée sous forme de chaîne de caractères convertie selon le charset indiqué. Il est possible de spécifier une valeur vide pour forcer l'enregistrement sans charset.
Retour¶
Objet pojo
contenant la valeur chiffrée sous la forme d'un tableau de
bytes. Si une option dest
est spécifiée, la méthode retourne le fichier
dans lequel les données ont été inscrites. Si une option charset
est
spécifiée, la méthode retourne la valeur encodée sous forme de chaîne de
caractères, selon le charset indiqué.
Exemple¶
Non disponible