Módulos

FTP

FTP

El módulo FTP es responsable de acceder a un servidor FTP y realizar la manipulación de archivos y directorios.

Métodos

connect

Método responsable de conectarse a un servidor FTP. Esa conexión será usada para todas las otras acciones de FTP. El FTP crea una conexión entre el dispositivo del usuario y un servidor, generalmente el equipo del servicio de hospedaje elegido. Por medio de él es posible realizar el intercambio de datos entre los sistemas, cuando estos están debidamente conectados a internet.

js

  const connection = await FTP.connect.v1_0_0({
    host: "ftp.exemplo.com.br",
    port: 21,
    user: "usuario",
    password: "senha"
  })

Parámetros obligatorios

• host: String - espera la dirección del servidor FTP (IP o hostname).
• port: Number - espera el número del puerto del servidor FTP. Generalmente el puerto predeterminado es 21.

Parámetros opcionales

• user: String - espera el nombre del usuario para la autenticación en el servidor FTP.
• password: String - espera la contraseña del usuario para la autenticación en el servidor FTP.
• connTimeout: Number - tiempo límite en milisegundos para establecer la conexión.
• pasvTimeout: Number - tiempo límite en milisegundos para operaciones en modo pasivo.
• keepalive: Number - intervalo en milisegundos para el envío de paquetes keepalive.

Retorno

La constante o variable creada, como la connection del ejemplo mostrado anteriormente, recibirá la instancia de conexión FTP, que debe pasarse como parámetro connection en todos los otros métodos del módulo FTP.

createDir

Acción responsable de crear un directorio en un servidor FTP.

js

  const createDir = await FTP.createDir.v1_0_0({
    path: '',
    recursive: true,
    connection: connection
  })

Parámetros obligatorios

• connection: espera una instancia del tipo connect con los nombres de los servidores FTP ya utilizados anteriormente. Basta con seleccionar aquel que deseas utilizar.
• path: String - espera un string con la ruta del directorio. Si utilizas solo /, el directorio será creado en la raíz del proyecto.
• recursive: Boolean - espera un valor booleano que indica si el nombre debe ser recursivo o no. Si pasas una ruta más allá de la raíz y esta no existe, será creada.

Retorno

Este método no tiene retorno.

deleteDir

Acción responsable de eliminar un directorio en un servidor FTP.

js

  const deleteDir = await FTP.deleteDir.v1_0_0({
    path: '',
    recursive: true,
    connection: connection
  })

Parámetros obligatorios

• connection: espera una instancia del tipo connect con los nombres de los servidores FTP ya utilizados anteriormente. Basta con seleccionar aquel que deseas utilizar.
• path: String - espera un string con la ruta del directorio. Si utilizas solo /, el directorio será creado en la raíz del proyecto.
• recursive: Boolean - espera un valor booleano que indica si el nombre debe ser recursivo o no. Si pasas una ruta más allá de la raíz y esta no existe, será creada.

Retorno

Este método no tiene retorno.

deleteFile

Acción responsable de eliminar un archivo en un servidor FTP.

js

  const deleteFile = await FTP.deleteFile.v1_0_0({
    path: '',
    connection: connection
  })

Parámetros obligatorios

• connection: espera una instancia del tipo connect con los nombres de los servidores FTP ya utilizados anteriormente. Basta con seleccionar aquel que deseas utilizar.
• path: String - espera un string con la ruta del archivo. El nombre del archivo debe estar al final de la ruta y acompañado de su extensión. Ejemplo: /documentos/pdfs/file.pdf.

Retorno

Este método no tiene retorno.

disconnect

Acción responsable de desconectarse de un servidor FTP.

js

  const disconnect = await FTP.disconnect.v1_0_0({
    connection: connection
  })

Parámetros obligatorios

• connection: espera una instancia del tipo connect con los nombres de los servidores FTP ya utilizados anteriormente. Basta con seleccionar aquel que deseas utilizar.

Retorno

Este método no tiene retorno.

getFile

Acción responsable de descargar un archivo a través de un servidor FTP ya abierto anteriormente.

js

  const getFile = await FTP.getFile.v1_0_0({
    connection: connection,
    localPath: '',
    remotePath: ''
  })

Parámetros obligatorios

• connection: espera una instancia del tipo connect con los nombres de los servidores FTP ya utilizados anteriormente. Basta con seleccionar aquel que deseas utilizar.
• remotePath: String - espera un string con la ruta del archivo. El nombre del archivo debe estar al final de la ruta y acompañado de su extensión. Ejemplo: /documentos/pdfs/file.pdf.
• localPath: String - espera un string con la ruta donde el archivo será guardado. El nombre del archivo debe estar al final de la ruta y acompañado de su extensión. Ejemplo: C:\Usuarios\Roberty\Downloads.

Retorno

Este método no tiene retorno.

list

Acción responsable de listar todo el contenido de un directorio.

js

  const list = await FTP.list.v1_0_0({
    connection: connection,
    path: ''
  })

Parámetros obligatorios

• connection: espera una instancia del tipo connect con los nombres de los servidores FTP ya utilizados anteriormente. Basta con seleccionar aquel que deseas utilizar.
• path: String - espera un string que debe completarse con la ruta del directorio cuyo contenido deseas listar. Ejemplo: /documentos.

Retorno

La constante o variable creada, como la list del ejemplo mostrado anteriormente, recibirá un objeto con las siguientes propiedades:

• list.count: Number - devuelve el total de elementos encontrados en el directorio.
• list.items: Array - array con los elementos encontrados. Cada elemento tiene las siguientes propiedades:
  • items[n].isDirectory: Boolean - indica si el elemento es un directorio.
  • items[n].isFile: Boolean - indica si el elemento es un archivo.
  • items[n].name: String - nombre del archivo o directorio.
  • items[n].size: Number - tamaño en bytes del archivo/directorio.
  • items[n].date: Date - fecha de la última modificación.

move

Acción responsable de renombrar o mover un archivo/directorio de un servidor FTP.

js

  const move = await FTP.move.v1_0_0({
    connection: connection,
    oldPath: '',
    newPath: ''
  })

Parámetros obligatorios

• connection: espera una instancia del tipo connect con los nombres de los servidores FTP ya utilizados anteriormente. Basta con seleccionar aquel que deseas utilizar.
• oldPath: String - espera un string que debe completarse con la ruta actual del directorio/archivo. Ejemplo: /documentos/planes-de-accion/presentacion.pdf.
• newPath: String - espera un string que debe completarse con la nueva ruta del directorio/archivo. Ejemplo: /documentos/planes/presentacion.pdf.

Retorno

Este método no tiene retorno.

putFile

Acción responsable de enviar un archivo a través de un servidor FTP ya abierto anteriormente.

js

  const putFile = await FTP.putFile.v1_0_0({
    connection: connection,
    localPath: '',
    remotePath: ''
  })

Parámetros obligatorios

• connection: espera una instancia del tipo connect con los nombres de los servidores FTP ya utilizados anteriormente. Basta con seleccionar aquel que deseas utilizar.
• remotePath: String - espera un string con la ruta donde el archivo será guardado. El nombre del archivo debe estar al final de la ruta y acompañado de su extensión. Ejemplo: /documentos/pdfs/file.pdf.
• localPath: String - espera un string con la ruta del archivo. El nombre del archivo debe estar al final de la ruta y acompañado de su extensión. Ejemplo: C:\Usuarios\Roberty\Downloads.

Retorno

Este método no tiene retorno.