How to Cast a JSON Object Inside of TypeScript Class?
Last Updated :
06 Dec, 2024
Casting a JSON object to a TypeScript class involves converting a plain JSON object (which lacks methods and proper typing) into an instance of a class that includes all the defined methods and type safety of that class.
Types of Objects in TypeScript
- Plain Objects: When parsing JSON data using the JSON.parse() method, we get a plain object, not a class instance.
- Class Objects: A class object is an instance of a TypeScript class with defined properties, constructors, and methods.
Example Scenario
Data 1: TypeScript Class Definition
Suppose we have a TypeScript class defined on the client-side:
JavaScript
class Todo {
userId: number;
id: number;
title: string;
done: boolean;
getTitle() {
return this.title;
}
isDone() {
return this.done;
}
}
Data 2: JSON Object
We have a JSON object stored locally in our project:
JavaScript
{
"userId": 1,
"id": 1,
"title": "Add Info about the new project",
"done": true
}
1. Using Object.assign() Method
First, we import the JSON object in our TypeScript file. We can then use the Object.assign() method to clone the JSON object into a Todo class object.
JavaScript
import jsonObhect from './todo.json';
// Defining our Todo class
class Todo {
userId: number;
id: number;
title: string;
done: boolean;
getTitle() {
return this.title;
}
isDone() {
return this.done;
}
}
// Object.assign() will clone jsonData into
// Todo class object Storing the new class
// object in a typescript variable
let newTodo = Object.assign(new Todo(), jsonData);
// Logging the output onto the console
console.log(newTodo);
console.log(newTodo.getTitle());
Output
Todo {
userId: 1,
id: 1,
title: 'Add Info about new project',
done: true
}
Add Info about new project
2. Using class-transformer
For more complex JSON objects or arrays of complex JSON objects, the class-transformer tool is more robust. It can transform plain JSON objects into TypeScript class instances.
Installation: Install the class-transformer package using npm:
npm install -g class-transformer
This method will take two parameters, the first parameter will be an instance of the Todo class and the second parameter is the JSON object imported from our local project. First, we will have to import the method from the class-transformer tool in our TypeScript file, so that TypeScript knows which method to use. Again, we have stored my JSON file in the same directory as that of my TypeScript file.
JavaScript
import jsonObhect from './todo.json';
import { plainToClass } from "class-transformer";
// Defining our Todo class
class Todo {
userId: number;
id: number;
title: string;
done: boolean;
getTitle() {
return this.title;
}
isDone() {
return this.done;
}
}
// plainToClass method will convert
// JSON data to Todo class object
// Storing the new class object in
// a typescript variable
let newTodo = plainToClass(Todo, jsonData);
// Logging the output to the console
console.log(newTodo);
console.log(newTodo.isDone());
Output
Todo {
userId: 1,
id: 1,
title: 'Add Info about new project',
done: true
}
true
Note: Converting JSON to TypeScript Interfaces
Another useful tool for converting JSON data to TypeScript interfaces is json2ts. This tool generates TypeScript interfaces from JSON objects. For the given JSON object, we can generate the following TypeScript interface:
TypeScript
declare module namespace {
export interface RootObject {
userId: number;
id: number;
title: string;
done: boolean;
}
}
Similar Reads
Non-linear Components In electrical circuits, Non-linear Components are electronic devices that need an external power source to operate actively. Non-Linear Components are those that are changed with respect to the voltage and current. Elements that do not follow ohm's law are called Non-linear Components. Non-linear Co
11 min read
JavaScript Tutorial JavaScript is a programming language used to create dynamic content for websites. It is a lightweight, cross-platform, and single-threaded programming language. It's an interpreted language that executes code line by line, providing more flexibility.JavaScript on Client Side: On the client side, Jav
11 min read
Web Development Web development is the process of creating, building, and maintaining websites and web applications. It involves everything from web design to programming and database management. Web development is generally divided into three core areas: Frontend Development, Backend Development, and Full Stack De
5 min read
Spring Boot Tutorial Spring Boot is a Java framework that makes it easier to create and run Java applications. It simplifies the configuration and setup process, allowing developers to focus more on writing code for their applications. This Spring Boot Tutorial is a comprehensive guide that covers both basic and advance
10 min read
React Interview Questions and Answers React is an efficient, flexible, and open-source JavaScript library that allows developers to create simple, fast, and scalable web applications. Jordan Walke, a software engineer who was working for Facebook, created React. Developers with a JavaScript background can easily develop web applications
15+ min read
Class Diagram | Unified Modeling Language (UML) A UML class diagram is a visual tool that represents the structure of a system by showing its classes, attributes, methods, and the relationships between them. It helps everyone involved in a projectâlike developers and designersâunderstand how the system is organized and how its components interact
12 min read
JavaScript Interview Questions and Answers JavaScript (JS) is the most popular lightweight, scripting, and interpreted programming language. JavaScript is well-known as a scripting language for web pages, mobile apps, web servers, and many other platforms. Both front-end and back-end developers need to have a strong command of JavaScript, as
15+ min read
React Tutorial React is a JavaScript Library known for front-end development (or user interface). It is popular due to its component-based architecture, Single Page Applications (SPAs), and Virtual DOM for building web applications that are fast, efficient, and scalable.Applications are built using reusable compon
8 min read
Steady State Response In this article, we are going to discuss the steady-state response. We will see what is steady state response in Time domain analysis. We will then discuss some of the standard test signals used in finding the response of a response. We also discuss the first-order response for different signals. We
9 min read
Backpropagation in Neural Network Back Propagation is also known as "Backward Propagation of Errors" is a method used to train neural network . Its goal is to reduce the difference between the modelâs predicted output and the actual output by adjusting the weights and biases in the network.It works iteratively to adjust weights and
9 min read