تحويل JSON إلى أنواع io-ts — Numio

متى تستخدمها

• التحقق من استجابة API وقت التشغيل في تطبيق TypeScript مبني على fp-ts وio-ts.
• صياغة codecs أولية لملف إعدادات JSON يجب فحصه قبل الاستخدام.

طريقة الاستخدام

1. الصق كائن JSON؛ وأدرج عدة عناصر مصفوفة إذا كانت بعض المفاتيح اختيارية.
2. اقرأ الـ codecs المُنشأة: اسم الجذر RootInterface، وتُسمّى المتداخلة بحسب مفاتيحها (يصبح settings هو Settings).
3. انسخ الشيفرة، وصدّر الـ codecs التي تحتاجها، واشتق الأنواع باستخدام t.TypeOf.

{
  "id": "u_1",
  "name": "Ada",
  "age": 36,
  "nickname": null,
  "settings": { "theme": "dark", "fontSize": 14 },
  "posts": [
    { "title": "Notes", "draft": true },
    { "title": "Engine" }
  ]
}

import * as t from "io-ts"

const Settings = t.type({
  theme: t.string,
  fontSize: t.number,
})

const Posts = t.intersection([
  t.type({
    title: t.string,
  }),
  t.partial({
    draft: t.boolean,
  }),
])

const RootInterface = t.type({
  id: t.string,
  name: t.string,
  age: t.number,
  nickname: t.null,
  settings: Settings,
  posts: t.array(Posts),
})

التفاصيل والقيود

يُنشأ في المتصفح بمولّد الموقع الخاص ويُنسَّق بـ Prettier؛ لا توجد إعدادات في الصفحة ولا تُرسل أي طلب إلى الخادم.

تُخرَج الـ codecs بدءًا بالاعتماديات، فيكون كل const معرّفًا قبل أن يشير إليه RootInterface.

تصبح الأرقام t.number (الصحيحة والعشرية على حد سواء). تعطي null النوع t.null، أو t.union([X, t.null]) عندما يكون للعيّنات الأخرى قيمة؛ وتعطي المصفوفات الفارغة t.array(t.unknown).

تذهب المفاتيح المفقودة من بعض عناصر المصفوفة إلى t.partial، وتُجمع مع المفاتيح الإلزامية عبر t.intersection.

FAQ

أدوات ذات صلة

المواصفات والمراجع

• io-ts on GitHub