Saltar al contenido principal
Ir al Studio
Módulos

File Manager

File Manager

El módulo File Manager es responsable de realizar acciones de manipulación de archivos y carpetas. Sus métodos pueden accederse conforme al ejemplo a continuación:

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 responsable de copiar un archivo o carpeta con todos sus archivos a otra carpeta indicada.

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

Parámetros obligatorios​

  • pathFrom: String - espera un string con la ruta del archivo o carpeta que será copiado.
  • pathTo: String - espera un string con la ruta del archivo o carpeta donde será pegado el archivo o carpeta copiado.

Parámetros opcionales​

  • overwrite: Boolean - espera un valor booleano que indica si el archivo o carpeta será sobrescrito. Si el valor es false, los archivos con el mismo nombre no serán modificados.

Retorno​

Este método no tiene retorno.

createFile​

Método responsable de crear un archivo.

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

Parámetros obligatorios​

  • fileName: String - espera un string con el nombre del archivo que será creado.
  • filePath: String - espera un string con la ruta del archivo que será creado.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada, como la path del ejemplo mostrado anteriormente, recibirá un string con la ruta del archivo creado.

createFolder​

Método responsable de crear una carpeta.

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

Parámetros obligatorios​

  • path: String - espera un string con la ruta de la carpeta que será creada. La última parte de la ruta debe ser el nombre de la carpeta.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

exists​

Método responsable de verificar si un archivo o carpeta existe.

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

Parámetros obligatorios​

  • pathFile: String - espera un string con la ruta del archivo o carpeta que será verificado.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada, como la exists del ejemplo mostrado anteriormente, recibirá un valor booleano que indica si el archivo o carpeta existe.

move​

Método responsable de mover un archivo o carpeta con todos sus archivos a otra carpeta indicada.

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

Parámetros obligatorios​

  • pathFrom: String - espera un string con la ruta del archivo o carpeta que será movido.
  • pathTo: String - espera un string con la ruta del archivo o carpeta hacia donde serán movidos los archivos o la carpeta.

Parámetros opcionales​

  • overwrite: Boolean - espera un valor booleano que indica si el archivo o carpeta será sobrescrito. Si el valor es false, los archivos con el mismo nombre no serán modificados en la carpeta de destino.

Retorno​

Este método no tiene retorno.

readFolder​

Método responsable de leer los contenidos existentes en una carpeta.

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

Parámetros obligatorios​

  • folderPath: String - espera un string con la ruta de la carpeta que será leída.

Parámetros opcionales​

  • fullPath: Boolean - espera un valor booleano que indica si se devolverá la ruta completa. Si el valor es true, se devolverán las rutas completas de los archivos existentes en la carpeta; en caso contrario, solo se devolverán los nombres de los archivos.
  • recursive: Boolean - espera un valor booleano que indica si los archivos que están en las subcarpetas de la ruta también deben devolverse. Si el valor es true, se devolverán los archivos existentes en las subcarpetas; en caso contrario, solo se devolverán los archivos existentes en la carpeta indicada.

Retorno​

La constante o variable creada, como la files del ejemplo mostrado anteriormente, recibirá un objeto que dará acceso a las siguientes propiedades:

  • files.values: String[] - devuelve un array de strings con los nombres de todos los archivos leídos.
  • files.count: Number - devuelve un número que representa la cantidad de archivos leídos.

readOnlyFolders​

Método responsable de leer solo las subcarpetas existentes en una carpeta, ignorando los archivos.

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

Parámetros obligatorios​

  • folderPath: String - espera un string con la ruta de la carpeta que será leída.

Parámetros opcionales​

  • recursive: Boolean - espera un valor booleano que indica si las subcarpetas anidadas también serán devueltas. Valor predeterminado: false.
  • fullPath: Boolean - espera un valor booleano que indica si se devolverá la ruta completa de las carpetas. Si es false, devuelve solo el nombre de las carpetas. Valor predeterminado: false.

Retorno​

La constante o variable creada, como la folders del ejemplo mostrado anteriormente, recibirá un objeto que dará acceso a las siguientes propiedades:

  • folders.values: String[] - devuelve un array de strings con los nombres o rutas de las carpetas encontradas.
  • folders.count: Number - devuelve la cantidad de carpetas encontradas.

readTextFile​

Método responsable de leer un archivo de texto.

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

Parámetros obligatorios​

  • filePath: String - espera un string con la ruta del archivo que será leído.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada, como la text del ejemplo mostrado anteriormente, recibirá un string con el contenido del archivo leído.

remove​

Método responsable de eliminar un archivo o carpeta.

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

Parámetros obligatorios​

  • path: String - espera un string con la ruta del archivo o carpeta que será eliminado.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

rename​

Método responsable de renombrar un archivo o carpeta.

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

Parámetros obligatorios​

  • path: String - espera un string con la ruta del archivo o carpeta que será renombrado.
  • newName: String - espera un string con el nuevo nombre del archivo o carpeta.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

writeFile​

Método responsable de escribir en un archivo de texto. Si ese archivo tiene contenido, el contenido será totalmente reemplazado.

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

Parámetros obligatorios​

  • filePath: String - espera un string con la ruta del archivo que será escrito.
  • content: String - espera un string con el contenido que será escrito en el archivo.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

zip​

Método responsable de comprimir archivos o una carpeta en un archivo .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 obligatorios​

  • pathFileZip: String - espera un string con la ruta del archivo zip que será creado.
  • pathsToZip: String[] - espera un array de strings con la ruta de todos los archivos que serán comprimidos.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.

unZip​

Método responsable de descomprimir un archivo .zip.

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

Parámetros obligatorios​

  • pathFileUnzip: String - espera un string con la ruta de la carpeta en la que los archivos serán descomprimidos.
  • pathZippedFile: String - espera un string con la ruta del archivo .zip que será descomprimido.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Este método no tiene retorno.