Parsing JSON Files in TypeScript Using Node.js

Welcome to the lesson on parsing JSON files in TypeScript using Node.js. You've learned about JSON-like structures and their representation in TypeScript. Today, we will dive deeper into parsing JSON files, an essential skill for working with data sources in the real world, while leveraging TypeScript's type safety features.

JSON (JavaScript Object Notation) is a widely used format for data exchange. Since many web applications and APIs opt for JSON due to its simplicity, it's crucial for developers to efficiently parse JSON data. This lesson focuses on utilizing Node.js's built-in fs module to parse JSON data from files, demonstrating how TypeScript's type system can enhance clarity and reduce errors.

Before we parse a JSON file, let's briefly revisit JSON's hierarchical structure. JSON comprises key-value pairs, objects, and arrays. Recall:

• Key-Value Pairs: The foundation of JSON. A key is always a string, while the value can be a string, number, object, array, true, false, or null.

• Objects: Collections of key-value pairs enclosed in curly braces ({}).

• Arrays: Ordered lists of values enclosed in square brackets ([]).

Here's an example JSON snippet to illustrate:

{
    "name": "Greenwood High",
    "location": {
        "city": "New York",
        "state": "NY"
    },
    "students": [
        {"name": "Emma", "age": 15},
        {"name": "Liam", "age": 14}
    ]
}

In this structure, "name", "location", and "students" are keys. "location" points to another object, and "students" is an array of objects.

Now, let's move on to reading JSON files using TypeScript. This process involves using Node.js's fs module, specifically the fs.readFile method.

We'll use import to bring in the fs module and read from the file. TypeScript allows us to explicitly declare variable types, enhancing readability and reducing mistakes.

import fs from 'fs';

const filePath: string = 'data.json';

fs.readFile(filePath, 'utf8', (err, jsonString: string) => {
  if (err) {
    console.error('Error reading file:', err);
    return;
  }
  // File successfully read
});

Here, filePath is the path to the JSON file with a declared type of string. The fs.readFile function reads the file with UTF-8 encoding, and the callback function handles errors and data processing.