FTP

O módulo FTP é responsável por acessar um servidor FTP e realizar manipulação de arquivos e diretórios.

Métodos

connect

Método responsável por conectar em um servidor FTP. Essa conexão será usada para todas as outras ações de FTP. O FTP cria uma conexão entre o dispositivo do usuário e um servidor, geralmente o equipamento do serviço de hospedagem escolhido. Por meio dele é possível realizar a troca de dados entre os sistemas, quando esses estão devidamente conectados à internet.

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

Parâmetros obrigatórios

• host: String - espera o endereço do servidor FTP (IP ou hostname).
• port: Number - espera o número da porta do servidor FTP. Geralmente a porta padrão é 21.

Parâmetros opcionais

• user: String - espera o nome do usuário para autenticação no servidor FTP.
• password: String - espera a senha do usuário para autenticação no servidor FTP.
• connTimeout: Number - tempo limite em milissegundos para estabelecer a conexão.
• pasvTimeout: Number - tempo limite em milissegundos para operações em modo passivo.
• keepalive: Number - intervalo em milissegundos para envio de pacotes keepalive.

Retorno

A constante ou variável criada, como a connection do exemplo mostrado anteriormente, receberá a instância de conexão FTP, que deve ser passada como parâmetro connection em todos os outros métodos do módulo FTP.

createDir

Ação responsável por criar um diretório em um servidor FTP.

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

Parâmetros obrigatórios

• connection: espera uma instância do tipo connect com os nomes dos servidores FTP já utilizados anteriormente. Basta selecionar aquele em que deseja utilizar.
• path: String - espera uma string com o caminho do diretório. Caso utilize apenas /, o diretório será criado na raiz do projeto.
• recursive: Boolean - espera um valor booleano que indica se o nome deve ser recursivo ou não. Caso passe um caminho além da raiz e ele não exista, o mesmo será criado.

Retorno

Este método não possui retorno.

deleteDir

Ação responsável por deletar um diretório em um servidor FTP.

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

Parâmetros obrigatórios

• connection: espera uma instância do tipo connect com os nomes dos servidores FTP já utilizados anteriormente. Basta selecionar aquele em que deseja utilizar.
• path: String - espera uma string com o caminho do diretório. Caso utilize apenas /, o diretório será criado na raiz do projeto.
• recursive: Boolean - espera um valor booleano que indica se o nome deve ser recursivo ou não. Caso passe um caminho além da raiz e ele não exista, o mesmo será criado.

Retorno

Este método não possui retorno.

deleteFile

Ação responsável por deletar um arquivo em um servidor FTP.

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

Parâmetros obrigatórios

• connection: espera uma instância do tipo connect com os nomes dos servidores FTP já utilizados anteriormente. Basta selecionar aquele em que deseja utilizar.
• path: String - espera uma string com o caminho do arquivo. O nome do arquivo deve estar no final do caminho e acompanhado de sua extensão. Exemplo: /documentos/pdfs/file.pdf.

Retorno

Este método não possui retorno.

disconnect

Ação responsável por desconectar de um servidor FTP.

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

Parâmetros obrigatórios

• connection: espera uma instância do tipo connect com os nomes dos servidores FTP já utilizados anteriormente. Basta selecionar aquele em que deseja utilizar.

Retorno

Este método não possui retorno.

getFile

Ação responsável por baixar um arquivo através de um servidor FTP já aberto anteriormente.

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

Parâmetros obrigatórios

• connection: espera uma instância do tipo connect com os nomes dos servidores FTP já utilizados anteriormente. Basta selecionar aquele em que deseja utilizar.
• remotePath: String - espera uma string com o caminho do arquivo. O nome do arquivo deve estar no final do caminho e acompanhado de sua extensão. Exemplo: /documentos/pdfs/file.pdf.
• localPath: String - espera uma string com o caminho onde o arquivo será salvo. O nome do arquivo deve estar no final do caminho e acompanhado de sua extensão. Exemplo: C:\Usuários\Roberty\Downloads.

Retorno

Este método não possui retorno.

list

Ação responsável por listar todo o conteúdo de um diretório.

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

Parâmetros obrigatórios

• connection: espera uma instância do tipo connect com os nomes dos servidores FTP já utilizados anteriormente. Basta selecionar aquele em que deseja utilizar.
• path: String - espera uma string que deve ser preenchido com o caminho do diretório que deseja listar seu conteúdo. Exemplo: /documentos.

Retorno

A constante ou variável criada, como a list do exemplo mostrado anteriormente, receberá um objeto com as seguintes propriedades:

• list.count: Number - retorna o total de itens encontrados no diretório.
• list.items: Array - array com os itens encontrados. Cada item possui as seguintes propriedades:
  • items[n].isDirectory: Boolean - indica se o item é um diretório.
  • items[n].isFile: Boolean - indica se o item é um arquivo.
  • items[n].name: String - nome do arquivo ou diretório.
  • items[n].size: Number - tamanho em bytes do arquivo/diretório.
  • items[n].date: Date - data da última modificação.

move

Ação responsável por renomear ou mover arquivo/diretório de um servidor FTP.

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

Parâmetros obrigatórios

• connection: espera uma instância do tipo connect com os nomes dos servidores FTP já utilizados anteriormente. Basta selecionar aquele em que deseja utilizar.
• oldPath: String - espera uma string que deve ser preenchido com o caminho atual do diretório/arquivo. Exemplo: /documentos/planos-de-acao/apresentacao.pdf.
• newPath: String - espera uma string que deve ser preenchido com o novo caminho do diretório/arquivo. Exemplo: /documentos/planos/apresentacao.pdf.

Retorno

Este método não possui retorno.

putFile

Ação responsável por enviar um arquivo através de um servidor FTP, já aberto anteriormente.

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

Parâmetros obrigatórios

• connection: espera uma instância do tipo connect com os nomes dos servidores FTP já utilizados anteriormente. Basta selecionar aquele em que deseja utilizar.
• remotePath: String - espera uma string com o caminho onde o arquivo será salvo. O nome do arquivo deve estar no final do caminho e acompanhado de sua extensão. Exemplo: /documentos/pdfs/file.pdf.
• localPath: String - espera uma string com o caminho do arquivo. O nome do arquivo deve estar no final do caminho e acompanhado de sua extensão. Exemplo: C:\Usuários\Roberty\Downloads.

Retorno

Este método não possui retorno.