JSON को TypeScript में बदलें

JSON उदाहरण से TypeScript इंटरफ़ेस बनाएँ।

इनपुट
परिणाम

उपयोग के उदाहरण

API रिस्पॉन्स के लिए झटपट टाइप तैयार करना

अपने सर्वर से मिला JSON रिस्पॉन्स का उदाहरण पेस्ट करें और सीधे प्रोजेक्ट में इस्तेमाल करने लायक TypeScript इंटरफ़ेस का ड्राफ्ट पाएँ।

नेस्टेड ऑब्जेक्ट को अपने आप अलग इंटरफ़ेस में बाँटना

जब आपके JSON में कोई और ऑब्जेक्ट हो, तो वह फ़ील्ड के नाम के आधार पर अपना अलग इंटरफ़ेस पाता है, जिससे सब कुछ व्यवस्थित रहता है।

ऐरे के आइटम अलग होने पर फ़ील्ड को ऑप्शनल दिखाना

जब ऐरे के ऑब्जेक्ट्स में सभी फ़ील्ड एक जैसे न हों, तो उन्हें एक ही इंटरफ़ेस में मिला दिया जाता है और जो फ़ील्ड हर जगह नहीं है उस पर '?' ऑप्शनल निशान लगा दिया जाता है।

GraphQL या वेबहुक पेलोड के लिए टाइप का प्रोटोटाइप बनाना

'{"event": "order.created", "data": {"id": "ord_1", "total": 42.5}}' जैसा नमूना पेलोड पेस्ट करें और वेबहुक हैंडलर के लिए टाइप किए इंटरफ़ेस हाथ से लिखे बिना जल्दी पाएँ।

जाँचना कि null मान कैसे टाइप होते हैं

अपने नमूने में '{"middleName": null}' जैसा फ़ील्ड शामिल करें और देखें कि टूल बने हुए इंटरफ़ेस में nullable फ़ील्ड को कैसे दर्शाता है।

त्वरित संदर्भ

JSON values → TypeScript types

JSONTypeScript
"hello"type Root = string;
42type Root = number;
3.14type Root = number;
truetype Root = boolean;
nulltype Root = null;
[]type Root = unknown[];
[1, 2, 3]type Root = number[];
["a", "b"]type Root = string[];
[1, "a", true]type Root = (number | string | boolean)[];
[1, null]type Root = (number | null)[];
[[1, 2], [3]]type Root = number[][];
{}interface Root { }

JSON objects → TypeScript interfaces

JSONTypeScript
{"id": 1, "name": "Ada"}interface Root { id: number; name: string; }
{"deletedAt": null}interface Root { deletedAt: null; }
{"tags": ["a", "b"]}interface Root { tags: string[]; }
{"user": {"id": 1}}interface User { id: number; } interface Root { user: User; }
{"items": [{"id": 1}, {"id": 2, "note": "x"}]}interface Item { id: number; note?: string; } interface Root { items: Item[]; }
{"categories": [{"name": "x"}]}interface Category { name: string; } interface Root { categories: Category[]; }
{"first-name": "Ada"}interface Root { "first-name": string; }
{"a": {"x": 1}, "b": {"x": 2}}interface A { x: number; } interface Root { a: A; b: A; }

अक्सर पूछे जाने वाले सवाल

क्या मेरा JSON सर्वर पर भेजा जाता है?

नहीं। सारा रूपांतरण पूरी तरह आपके ब्राउज़र में होता है, और आपके द्वारा दर्ज कुछ भी कभी सर्वर पर नहीं भेजा जाता।

क्या जनरेट किया कोड बिना बदले इस्तेमाल कर सकता हूँ?

यह सिर्फ़ एक JSON उदाहरण से अनुमान लगाया गया है, इसलिए यह आपके असली डेटा की हर संभावना को पूरी तरह न दर्शा पाए। जनरेट किए इंटरफ़ेस को शुरुआती बिंदु मानें और ज़रूरत के हिसाब से उसे ठीक करें।

क्या डेट स्ट्रिंग को भी Date टाइप के रूप में पहचाना जाता है?

नहीं। JSON में कोई अलग डेट टाइप नहीं होता, इसलिए हर स्ट्रिंग को string माना जाता है। अगर आप इसे डेट की तरह इस्तेमाल करना चाहते हैं, तो जनरेट किए कोड को खुद बदलें।

अगर एक जैसी शक्ल का ऑब्जेक्ट कई बार आए तो क्या होता है?

एक जैसी संरचना वाले ऑब्जेक्ट डुप्लीकेट इंटरफ़ेस बनाने की बजाय एक ही इंटरफ़ेस फिर से इस्तेमाल करते हैं।

ख़ाली ऐरे को कैसे टाइप किया जाता है?

चूँकि ख़ाली ऐरे अपने एलिमेंट प्रकार का कोई संकेत नहीं देता, उसे 'unknown[]' टाइप किया जाता है। अगर आप ज़्यादा ख़ास एलिमेंट प्रकार चाहते हैं, तो ऐरे में कम से कम एक नमूना एलिमेंट जोड़ें।

null मान को कौन-सा TypeScript प्रकार मिलता है?

जिस फ़ील्ड का नमूना मान null है, उसे 'null' टाइप किया जाता है। अगर आप जानते हैं कि फ़ील्ड में दूसरे प्रकार भी हो सकते हैं, जैसे स्ट्रिंग या ग़ैरमौजूद होना, तो आपको बने हुए प्रकार को हाथ से चौड़ा करना होगा, उदाहरण के लिए 'string | null' में।

क्या मेरे JSON में फ़ील्ड का क्रम बने हुए इंटरफ़ेस पर असर डालता है?

नहीं। फ़ील्ड बने हुए इंटरफ़ेस में उसी क्रम में सूचीबद्ध होते हैं जिसमें वे आपके इनपुट में हैं, पर सोर्स JSON में उन्हें दोबारा क्रम में लगाने का बने हुए प्रकारों पर ख़ुद कोई असर नहीं होता।