Leer archivo de texto en TypeScript

1. TypeScript con node.js
2. el módulo Node
3. el Módulo fs
4. Leer un archivo con el módulo fs

Este tutorial trata sobre cómo leer archivos de texto en TypeScript.

TypeScript con node.js

TypeScript es un superconjunto de JavaScript. Si bien hereda todas las funciones de JavaScript, proporciona muchas funciones potentes listas para usar que no están incluidas en JavaScript.

El node.js es un marco de JavaScript que nos permite escribir JavaScript en el lado del servidor. Hizo una diferencia considerable con respecto a la norma típica de ejecución de JavaScript basada en navegador.

Para desarrollar con node.js y TypeScript, debe tener node.js instalado. Puede verificar si el Nodo se ha instalado o no usando el siguiente comando.

node -v

El comando anterior debería mostrar la versión node.js actualmente instalada. De lo contrario, debe instalar node.js desde el sitio oficial.

Además, su máquina debe tener un paquete compilador de TypeScript. Verifíquelo ejecutando el siguiente comando.

tsc --version

Debería mostrar la versión del compilador de TypeScript.

el módulo Node

Con la inclusión de node.js, TypeScript puede utilizar los paquetes NPM sin problemas. NPM proporciona miles de paquetes y bibliotecas de código abierto que cualquier aplicación puede usar para implementar funcionalidades específicas en muy poco tiempo.

Los paquetes node.js están escritos en lenguaje JavaScript. Por lo tanto, debe instalar las definiciones de tipo para los paquetes NPM por adelantado.

Instalemos las definiciones de tipo de node como se muestra a continuación.

npm install --save-dev @types/node

Instalaría todas las definiciones de tipo para paquetes de node.

el Módulo fs

El módulo fs es un paquete ampliamente conocido que se utiliza para interactuar con el sistema de archivos. Ofrece una amplia gama de funciones para manejar un sistema de archivos local, como leer de un archivo, escribir en un archivo, eliminar un directorio, agregar a un archivo, etc.

Leer un archivo con el módulo fs

El módulo fs es compatible con las API asíncronas y síncronas para leer desde un archivo.

readFileSync(path, [encoding])

or

readFile(path, [encoding], callback_function)

Utilice la función readFileSync() en TypeScript

La función readFileSync() puede leer un archivo sincrónicamente. Bloquea la ejecución hasta que finaliza la operación de lectura del archivo.

Importemos primero el módulo fs. Por lo general, node.js usa require() para importar paquetes.

Como usamos TypeScript aquí, podemos usar import.

import * as fs from 'fs';

Esto importaría todas las funciones dentro del paquete fs, y podemos llamarlas por fs.

A continuación, iniciaremos una variable para contener la ruta del archivo.

const fileName: string = 'example.txt';

Finalmente, llamaremos al método readFileSync() con los parámetros.

let fileContent = fs.readFileSync(fileName, 'utf8');
console.log(fileContent);

El parámetro de tipo de codificación debe establecerse en utf8. Luego, el método devolverá el contenido del archivo como una cadena.

De lo contrario, el contenido del archivo se devuelve como un valor de búfer.

Producción:

Como era de esperar, el contenido del archivo se ha registrado en la consola.

Utilice la función readFile() en TypeScript

El método readFile() puede leer un archivo del sistema de forma asíncrona. Por lo tanto, podemos pasar el parámetro de la función de devolución de llamada a esta función.

Importemos el fs e inicialicemos una variable para contener la ruta del archivo.

import * as fs from 'fs';
const fileName: string = 'example.txt';

Utilice el método readFile, como se muestra a continuación.

fs.readFile(fileName, 'utf8', (err, data)=> {
    console.log(data);
});

Podrías notar el mismo resultado que en el ejemplo anterior.