typeof-jsonc 将 JSONC/JSON 转换为 TypeScript 声明

àì夳堔傛蜴生んèń 2022-10-01 08:50 234阅读 0赞

## 1、TypeScript 带来的好处 ##

TypeScript 提供了静态类型检查，带来了如下好处：

*  质量：静态类型检查，规避类型错误
 *  高效：结合编辑器，智能提示，加快开发速度和保证代码质量
 *  重构：静态类型检查，重构低风险
 *  可读：类型声明使代码更可读

## 2、开发中存在的类型声明成本 ##

开发过程中需要更多的类型，以让 TypeScript 的效果更好，特别是前后端协作时，将接口文档信息转换为 TypeScript 类型声明，来保证项目质量。 但是手动的根据后端接口文档进行编辑，带来很高的编辑成本。

## 3、降低接口文档到 TS 声明成本的方案 ##

[typeof-jsonc][] lib 库支持将 `jsonc` 字符串转换为 TS 声明

待转换接口示例

{
      "code": 0,
      "data": {
            // this is name
            "name": "hello",
            // this is age
            "age": 18
      },
      "msg": "success"
    }
    复制代码

`typeof-jsonc` 转换结果

export interface IResponseData {
        code: number;
        data: IData;
        msg: string;
    }
    
    export interface IData {
        /** * this is name */
        name: string;
        /** * this is age */
        age: number;
    }
    
    复制代码

[线上工具截图][Link 1]

## 4、[typeof-jsonc][] 特性 ##

*  支持基本类型
 *  支持数组类型合并
 *  支持注释解析
 *  自定义类型名
 *  支持 jsonc、json、非标准的 jsonc/json 格式

转载于:https://juejin.im/post/5cd67c31518825686b1206a2

[typeof-jsonc]: https://link.juejin.im?target=https%3A%2F%2Fgithub.com%2Fwulunyi%2Ftypeof-jsonc
[Link 1]: https://link.juejin.im?target=http%3A%2F%2Flanfeng.fun%2F%23%2Ftypeofjsonc

发表评论取消回复

表情：

评论列表（有 0 条评论，234人围观）

还没有评论，来说两句吧...

相关阅读

相关 TypeScript初学者指南：将Java项目逐步升级为TypeScript

对于 TypeScript 初学者，如果你想将一个 Java 项目升级为 TypeScript，以下是逐步指南： 1. **理解 TypeScript**： - 首先你

超、凢脫俗/ 2024年09月11日 16:57/ 0 赞/ 110 阅读

相关将下面的代码转换成typescript

答：这里有一些代码帮助您将JavaScript代码转换为TypeScript：// JavaScript function add(x, y) \{ return x + y;

短命女/ 2024年03月25日 18:25/ 0 赞/ 47 阅读

相关 TypeScript 变量声明

TypeScript 变量声明本节介绍 `var` `let` `const` 这三种变量的声明方式，重点讨论作用域与变量提升的相关知识点，这部分往往也是面试常考部分，

今天药忘吃喽~/ 2023年07月24日 08:39/ 0 赞/ 25 阅读

相关 Typescript学习--函数声明

先看一下es5中定义函数的方式： // 函数声明 function run3() { } // 匿名函数 var run4 = functio

蔚落/ 2022年10月25日 00:50/ 0 赞/ 272 阅读

相关 typeof-jsonc 将 JSONC/JSON 转换为 TypeScript 声明

1、TypeScript 带来的好处 TypeScript 提供了静态类型检查，带来了如下好处：质量：静态类型检查，规避类型错误高效：结合编辑器，智能提

àì夳堔傛蜴生んèń/ 2022年10月01日 08:50/ 0 赞/ 235 阅读

相关将汉字转换为拼音

将汉字转换成拼音： / 1、实用类HanyuPinyinOutputFormat 设置输出格式（1）、setCaseType设置输出拼音大小写。

叁歲伎倆/ 2022年08月07日 01:46/ 0 赞/ 303 阅读

相关 TypeScript 类的声明

/\\ \TypeScript的类和java中的基本相同，有属性，构造函数，还有方法 \/ class cls{ //定义两个属性

超、凢脫俗/ 2022年07月15日 04:51/ 0 赞/ 248 阅读

相关将汉字转换为拼音

一：演示：如在控制台输入：北京欢迎你打印出来的拼音：bei jing huan ying ni 二：导入要依赖的jar： [汉

布满荆棘的人生/ 2022年07月10日 23:44/ 0 赞/ 320 阅读

相关 TypeScript 变量声明

一、变量声明 let和const是JavaScript里相对比较新的变量声明方式。推荐使用let 方式声明变量，来代替使用var。 TypeScript是JavaScri

布满荆棘的人生/ 2022年06月13日 00:13/ 0 赞/ 326 阅读

相关将字符串转换为数字

![这里写图片描述][70] public class Solution { public int StrToInt(String str) {

淡淡的烟草味﹌/ 2022年05月24日 03:22/ 0 赞/ 355 阅读