Pular para o conteúdo principal
Acessar Studio
Módulos

File Manager

File Manager

O módulo File Manager é responsável por realizar ações de manipulação de arquivos e pastas. Seus métodos podem ser acessados conforme o exemplo abaixo:

js
await FileManager.copy["v1_0_0"]({
  pathFrom: 'C:/Users/Roberty/Desktop/teste.txt',
  pathTo: 'C:/Users/Roberty/Desktop/teste2.txt',
})

Métodos​

copy​

Método responsável por copiar um arquivo ou pasta com todos os seus arquivos para outra pasta passada.

js
await FileManager.copy["v1_0_0"]({
  pathFrom: 'C:/Users/Roberty/Desktop/teste.txt',
  pathTo: 'C:/Users/Roberty/Desktop/teste2.txt',
})

Parâmetros obrigatórios​

  • pathFrom: String - espera uma string com o caminho do arquivo ou pasta que será copiado.
  • pathTo: String - espera uma string com o caminho do arquivo ou pasta onde será colado o arquivo ou pasta copiado.

Parâmetros opcionais​

  • overwrite: Boolean - espera um valor booleano que indica se o arquivo ou pasta será sobreescrito. Se o valor for false, arquivos de mesmo nome não serão modificados.

Retorno​

Este método não possui retorno.

createFile​

Método responsável por criar um arquivo.

js
const path = await FileManager.createFile["v1_0_0"]({
  fileName: 'teste.txt',
  filePath: 'C:/Users/Roberty/Desktop/',
})

Parâmetros obrigatórios​

  • fileName: String - espera uma string com o nome do arquivo que será criado.
  • filePath: String - espera uma string com o caminho do arquivo que será criado.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada, como a path do exemplo mostrado anteriormente, receberá uma string com o caminho do arquivo criado.

createFolder​

Método responsável por criar uma pasta.

js
await FileManager.createFolder["v1_0_0"]({
  path: 'C:/Users/Roberty/Desktop/teste',
})

Parâmetros obrigatórios​

  • path: String - espera uma string com o caminho da pasta que será criada. A última parte do caminho deve ser o nome da pasta.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Este método não possui retorno.

exists​

Método responsável por verificar se um arquivo ou pasta existe.

js
const exists = await FileManager.exists["v1_0_0"]({
  pathFile: 'C:/Users/Roberty/Desktop/teste.txt',
})

Parâmetros obrigatórios​

  • pathFile: String - espera uma string com o caminho do arquivo ou pasta que será verificado.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada, como a exists do exemplo mostrado anteriormente, receberá um valor booleano que indica se o arquivo ou pasta existe.

move​

Método responsável por mover um arquivo ou pasta com todos os seus arquivos para outra pasta passada.

js
await FileManager.move["v1_0_0"]({
  pathFrom: 'C:/Users/Roberty/Desktop/teste.txt',
  pathTo: 'C:/Users/Roberty/Desktop/teste2.txt',
})

Parâmetros obrigatórios​

  • pathFrom: String - espera uma string com o caminho do arquivo ou pasta que será movido.
  • pathTo: String - espera uma string com o caminho do arquivo ou pasta para onde os arquivos ou pasta serão movidos.

Parâmetros opcionais​

  • overwrite: Boolean - espera um valor booleano que indica se o arquivo ou pasta será sobreescrito. Se o valor for false, arquivos de mesmo nome não serão modificados na pasta de destino.

Retorno​

Este método não possui retorno.

readFolder​

Método responsável por ler os conteúdos existentes em uma pasta.

js
const files = await FileManager.readFolder["v1_0_0"]({
  folderPath: 'C:/Users/Roberty/Desktop/teste',
})

Parâmetros obrigatórios​

  • folderPath: String - espera uma string com o caminho da pasta que será lida.

Parâmetros opcionais​

  • fullPath: Boolean - espera um valor booleano que indica se o caminho completo será retornado. Se o valor for true, o caminho completo dos arquivos existentes na pasta serão retornados, caso contrário, apenas o nome dos arquivos serão retornados.
  • recursive: Boolean - espera um valor booleano que indica se os arquivos que estão nas subpastas do caminho devem ser retornados também. Se o valor for true, os arquivos existentes nas subpastas serão retornados, caso contrário, apenas os arquivos existentes na pasta passada serão retornados.

Retorno​

A constante ou variável criada, como a files do exemplo mostrado anteriormente, receberá um objeto que dará acesso às seguintes propriedades:

  • files.values: String[] - retorna um array de strings com os nomes de todos os arquivos lidos.
  • files.count: Number - retorna um número que representa a quantidade de arquivos lidos.

readOnlyFolders​

Método responsável por ler apenas as subpastas existentes em uma pasta, ignorando arquivos.

js
const folders = await FileManager.readOnlyFolders["v1_0_0"]({
  folderPath: 'C:/Users/Roberty/Desktop/teste',
})

Parâmetros obrigatórios​

  • folderPath: String - espera uma string com o caminho da pasta que será lida.

Parâmetros opcionais​

  • recursive: Boolean - espera um valor booleano que indica se as subpastas aninhadas também serão retornadas. Valor padrão: false.
  • fullPath: Boolean - espera um valor booleano que indica se o caminho completo das pastas será retornado. Se false, retorna apenas o nome das pastas. Valor padrão: false.

Retorno​

A constante ou variável criada, como a folders do exemplo mostrado anteriormente, receberá um objeto que dará acesso às seguintes propriedades:

  • folders.values: String[] - retorna um array de strings com os nomes ou caminhos das pastas encontradas.
  • folders.count: Number - retorna a quantidade de pastas encontradas.

readTextFile​

Método responsável por ler um arquivo de texto.

js
const text = await FileManager.readTextFile["v1_0_0"]({
  filePath: 'C:/Users/Roberty/Desktop/teste.txt',
})

Parâmetros obrigatórios​

  • filePath: String - espera uma string com o caminho do arquivo que será lido.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada, como a text do exemplo mostrado anteriormente, receberá uma string com o conteúdo do arquivo lido.

remove​

Método responsável por remover um arquivo ou pasta.

js
await FileManager.remove["v1_0_0"]({
  path: 'C:/Users/Roberty/Desktop/teste.txt',
})

Parâmetros obrigatórios​

  • path: String - espera uma string com o caminho do arquivo ou pasta que será removido.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Este método não possui retorno.

rename​

Método responsável por renomear um arquivo ou pasta.

js
await FileManager.rename["v1_0_0"]({
  path: 'C:/Users/Roberty/Desktop/teste.txt',
  newName: 'teste2.txt',
})

Parâmetros obrigatórios​

  • path: String - espera uma string com o caminho do arquivo ou pasta que será renomeado.
  • newName: String - espera uma string com o novo nome do arquivo ou pasta.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Este método não possui retorno.

writeFile​

Método responsável por escrever em um arquivo de texto. Caso esse arquivo possua conteúdo, o conteúdo será totalmente substituído.

js
await FileManager.writeFile["v1_0_0"]({
  filePath: 'C:/Users/Roberty/Desktop/teste.txt',
  content: 'Hellow World!',
})

Parâmetros obrigatórios​

  • filePath: String - espera uma string com o caminho do arquivo que será escrito.
  • content: String - espera uma string com o conteúdo que será escrito no arquivo.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Este método não possui retorno.

zip​

Método responsável por compactar arquivos ou pasta em um arquivo .zip.

js
await FileManager.zip["v1_0_0"]({
  pathFileZip: `C:/Users/Roberty/Desktop/arquivo.zip`,
  pathsToZip: [`C:/Users/Roberty/Desktop/arquivo1.txt`, `C:/Users/Roberty/Desktop/arquivo2.xlsx`]
})

Parâmetros obrigatórios​

  • pathFileZip: String - espera uma string com o caminho do arquivo zip que será criado.
  • pathsToZip: String[] - espera um array de string com o caminho de todos os arquivos que serão compactados.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Este método não possui retorno.

unZip​

Método responsável por descompactar um arquivo .zip.

js
await FileManager.unZip["v1_0_0"]({
  pathFileUnzip: `C:/Users/Roberty/Desktop`,
  pathZippedFile: `C:/Users/Roberty/Desktop/arquivo.zip`
})

Parâmetros obrigatórios​

  • pathFileUnzip: String - espera uma string com o caminho da pasta em que os arquivos serão descompactados.
  • pathZippedFile: String - espera uma string com o caminho do arquivo .zip que será descompactado.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Este método não possui retorno.