npm package: @mcsoft/archivos
Description: Librería de funciones útiles para el manejo de archivos.
Author: Jaime Brambila
Latest version: 1.0.1

# Utilerías de Archivos
Librería de utilerías para el manejo de archivos.

[![Software Type](https://img.shields.io/badge/McSoft-TypeScript%20Library-blue)](#)
[![Language](https://img.shields.io/badge/Language-Spanish-yellow)](#)
[![Software License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE)
[![Version](https://img.shields.io/npm/v/@mcsoft/archivos.svg)](https://www.npmjs.com/package/@mcsoft/archivos)
[![Downloads](https://img.shields.io/npm/dt/@mcsoft/archivos.svg)](https://www.npmjs.com/package/@mcsoft/archivos)

## Instalación

```bash
npm install --save @mcsoft/archivos
```

## Uso

```ts
import { miFuncion } from '@mcsoft/archivos';

const resultado = myFuncion('foo')
```

# Métodos

* [convertirBlobABase64](#convertirblobabase64archivoblob-blob-promise)
* [leerArchivoExcel](#leerarchivoexcelbuffer-buffer-numerohoja-string-number-promisearrayarray)
* [leerArchivoTexto](#leerarchivotextorutaarchivo-string-promise)
* [obtenerExtension](#obtenerextensionnombrearchivo-string-string)
* [obtenerTamano](#obtenertamanotamanobytes-number-string)

## convertirBlobABase64(archivoBlob: *Blob*): *Promise<string>*
Obtiene la cadena codificada en base64 apartir del blob del archivo.

### Parámetros
| Nombre      | Tipo | Descripción       |
|-------------|------|-------------------|
| archivoBlob | Blob | Blob del archivo. |

### Return
***string*** Regresa una cadena archivo codificado en base64.


## leerArchivoExcel(buffer: *Buffer*, numeroHoja: *string | number*): *Promise<Array<Array<any>>>*
Lee una hoja de un archivo de excel y regresa su contenido como un arreglo de arreglos.

### Parámetros
| Nombre     | Tipo                 | Descripción                       |
|------------|----------------------|-----------------------------------|
| buffer     | Buffer               | Buffer del archivo.               |
| numeroHoja | string &#124; number | Index o nombre de la hoja a leer. |

### Return
***Promise<Array<Array<any>>>*** Regresa un arreglo con los renglones de la hoja, cada renglon será un arreglo.


## leerArchivoTexto(rutaArchivo: *string*): *Promise<string>*
Lee un archivo de texto.

### Parámetros
| Nombre      | Tipo   | Descripción              |
|-------------|--------|--------------------------|
| rutaArchivo | string | Ruta del archivo a leer. |

### Return
***string*** Regresa una cadena con el contenido del archivo.

## obtenerExtension(nombreArchivo: *string*): *string*
Obtiene la extensión apartir del nombre del archivo.

### Parámetros
| Nombre        | Tipo   | Descripción                                 |
|---------------|--------|---------------------------------------------|
| nombreArchivo | string | Nombre del archivo incluyendo la extensión. |

### Return
***string*** Regresa una cadena con la extensión del archivo.


## obtenerTamano(tamanoBytes: *number*): *string*
Obtiene el tamaño del archivo.

### Parámetros
| Nombre      | Tipo   | Descripción                  |
|-------------|--------|------------------------------|
| tamanoBytes | number | Tamaño del archivo en bytes. |

### Return
***string*** Regresa una cadena con el tamaño del archivo y su unidad [bytes|KB|MB|GB].