newtype-ts: TypeScript中的新类型实现教程

newtype-ts: TypeScript中的新类型实现教程

newtype-ts Implementation of newtypes in TypeScript 项目地址: https://gitcode.com/gh_mirrors/ne/newtype-ts

项目介绍

newtype-ts 是一个在 TypeScript 中实现“新类型”概念的库，由 gcanti 开发维护。新类型（newtype）允许开发者创建一种新的类型，其运行时表现与已存在的类型相同，但在编译层面上具有独立的标识。例如，尽管 EUR 和 USD 在底层都是 number，但通过 newtype-ts 定义后，在类型系统中它们被视为截然不同的类型。这有助于增强类型安全性，尤其是在处理货币或其他对精度要求高的场景。

项目快速启动

要迅速开始使用 newtype-ts 库，首先确保你的开发环境安装了 Node.js 和 TypeScript。然后，遵循以下步骤：

安装依赖

通过 npm 来安装 newtype-ts 及其必要的依赖（fp-ts 和 monocle-ts 自从 0.3.0 版本起需要手动安装）：

npm install newtype-ts fp-ts monocle-ts

简单示例

接下来，我们创建一个简单的示例来展示如何定义一个代表欧元的新类型。

import { Newtype, iso } from 'newtype-ts';

// 定义EUR新类型
interface EUR extends Newtype<['readonly EUR'], number>[] {}
const isoEUR = iso<EUR>();

// 创建EUR实例
const myAmountEUR = isoEUR.wrap(1.5);

// 使用EUR类型
function saveAmount(amount: EUR): void {}

saveAmount(myAmountEUR); // 正确
// saveAmount(1.5); // 错误，因为1.5不是EUR类型

应用案例和最佳实践

在财务系统中，使用 newtype-ts 可以避免错误地将不同货币类型的数值相互混淆：

import { Newtype, iso } from 'newtype-ts';

interface USD extends Newtype<['readonly USD'], number>[] {}
const isoUSD = iso<USD>();

interface EUR extends Newtype<['readonly EUR'], number>[] {}
const isoEUR = iso<EUR>();

// 模拟转换函数，实际上这里应该进行汇率换算
function convertToEUR(usd: USD): EUR {
    return isoEUR.wrap(isoUSD.unwrap(usd)); // 假设汇率为1:1
}

const myUsdAmount = isoUSD.wrap(100);
const myEurAmount = convertToEUR(myUsdAmount); // 类型安全的货币转换

// 尝试直接传递不正确的类型会被编译器捕获
// saveAmount(myUsdAmount); // 错误
saveAmount(myEurAmount); // 正确

典型生态项目

虽然该问题没有具体要求列出与newtype-ts紧密相关的其他生态项目，但是值得提到的是fp-ts和monocle-ts这两个库，它们经常与newtype-ts一起使用来构建高内聚、类型安全的FP风格的TypeScript应用程序。fp-ts提供了丰富的函数式编程工具，而monocle-ts则增强了领域建模的能力，特别是在类型级别的视图和改造上。

---

以上就是关于newtype-ts的基本入门和一些实用案例。通过这些，你可以开始在自己的TypeScript项目中利用新类型来提升类型系统的严谨性。

newtype-ts Implementation of newtypes in TypeScript 项目地址: https://gitcode.com/gh_mirrors/ne/newtype-ts