Typecheck.macro 项目教程

Typecheck.macro 项目教程

typecheck.macro A easy (and fast) typescript validation library/macro. Automatically generate validation functions for Typescript types. 项目地址: https://gitcode.com/gh_mirrors/ty/typecheck.macro

1. 项目介绍

Typecheck.macro 是一个用于 TypeScript 的编译时验证库/宏。它能够自动为你的 TypeScript 类型生成验证函数，无需你编写额外的 DSL（领域特定语言）。Typecheck.macro 支持大部分 TypeScript 类型系统，包括联合类型、元组类型、可选类型、索引签名、接口、类型别名、泛型、对象模式和数组等。生成的验证函数性能优越，因为它在编译时生成纯 JavaScript 代码，避免了运行时的性能开销。

2. 项目快速启动

安装

如果你使用的是 Gatsby 或 Create React App，只需安装宏即可，无需其他步骤。否则，请按照以下步骤操作：

npm install typecheck.macro

配置

在 package.json 中添加以下配置：

{
  "scripts": {
    "build": "babel src --out-dir dist --extensions \".ts\""
  }
}

使用示例

import createValidator, { registerType } from 'typecheck.macro';

type A = [index: number, name: string];

registerType('A'); // 注册命名类型

const validator = createValidator<A>(); // 匿名类型验证
const validator2 = createValidator<[index: number, name: string]>(); // 混合使用
const validator3 = createValidator<[index: number, value: A]>(); // 包含命名类型的匿名类型验证

3. 应用案例和最佳实践

案例1：验证用户输入

假设你有一个用户注册表单，需要验证用户输入的数据是否符合预期类型。

type User = {
  id: number;
  name: string;
  email: string;
};

registerType('User');

const userValidator = createValidator<User>();

const userInput = {
  id: 1,
  name: 'John Doe',
  email: 'john.doe@example.com'
};

if (userValidator(userInput)) {
  console.log('用户输入有效');
} else {
  console.log('用户输入无效');
}

案例2：验证API响应

在处理API响应时，确保返回的数据结构符合预期类型。

type ApiResponse = {
  status: 'success' | 'error';
  data: {
    message: string;
  };
};

registerType('ApiResponse');

const responseValidator = createValidator<ApiResponse>();

const apiResponse = {
  status: 'success',
  data: {
    message: '操作成功'
  }
};

if (responseValidator(apiResponse)) {
  console.log('API响应有效');
} else {
  console.log('API响应无效');
}

4. 典型生态项目

1. Babel

Typecheck.macro 依赖于 Babel 进行编译时宏处理。Babel 是一个广泛使用的 JavaScript 编译器，支持多种插件和宏扩展。

2. TypeScript

Typecheck.macro 是专门为 TypeScript 设计的，充分利用了 TypeScript 的类型系统。TypeScript 是一个强类型的 JavaScript 超集，广泛应用于现代前端开发。

3. Gatsby 和 Create React App

如果你使用 Gatsby 或 Create React App 进行项目开发，Typecheck.macro 可以无缝集成，无需额外配置。

4. Ajv

Ajv 是一个高性能的 JSON 模式验证器，Typecheck.macro 在性能上与之相当，甚至在某些情况下更优。

通过以上模块的介绍，你可以快速上手并深入了解 Typecheck.macro 的使用和生态。

typecheck.macro A easy (and fast) typescript validation library/macro. Automatically generate validation functions for Typescript types. 项目地址: https://gitcode.com/gh_mirrors/ty/typecheck.macro