True Myth 使用指南

True Myth 使用指南

true-mythA library for safer and smarter error- and "nothing"-handling in TypeScript.项目地址:https://gitcode.com/gh_mirrors/tr/true-myth

项目介绍

True Myth 是一个专为 TypeScript 设计的安全且惯用的库，旨在处理编程中普遍存在的两个核心问题：空值处理和错误管理。它提供了类型安全的 Maybe 和 Result 类型，以及一系列辅助函数，支持既可采用函数式风格也可采用更传统的方法调用风格。True Myth 的设计特别注重于在 TypeScript 环境中的严谨类型安全性，相比于其他如JavaScript-first的库（例如Folktale），True Myth 更强调编译时的类型检查和TypeScript的紧密结合。

项目快速启动

要快速开始使用 True Myth，首先需要安装它到你的项目中：

npm install true-myth # 或者使用 yarn add true-myth

之后，在你的 TypeScript 项目中导入并使用 Maybe 或 Result 类型：

// 导入Maybe类型
import { Maybe } from 'true-myth';

function testMaybe(value: number | null): Maybe<number> {
    // 使用 Maybe.of 构建Maybe实例，自动处理null或undefined
    const maybeNum = Maybe.of(value);
    
    // 示例：安全地从Maybe中提取值或默认值
    const safeNum = maybeNum.getOrElse(0); // 如果是Nothing，则返回0
    
    return maybeNum;
}

// 快速启动示例结束

确保你的 TypeScript 配置支持 ES 模块，或者遵循官方文档中关于如何在 TypeScript 中正确设置纯 ES 模块的指导。

应用案例和最佳实践

安全处理可选值

在处理可能为 null 或 undefined 的变量时，最佳实践是利用 Maybe.of 来构建 Maybe 实例，从而避免运行时错误。

const processOptionalValue = (value: string | null): Maybe<string> => {
    return Maybe.of(value)
        .map(val => val.trim()) // 自动处理Nothing，不会抛错
        .filter(val => val !== ''); // 过滤掉空字符串
};

const exampleVal = null;
const processed = processOptionalValue(exampleVal);
if (processed.isJust()) {
    console.log(processed.get()); // 输出空字符串或处理后的非空值
} else {
    console.log("Value was missing.");
}

错误处理

使用 Result 类型来封装可能会失败的操作，使得错误处理更加明确和安全。

import { Result, Err, Ok } from 'true-myth';

const divideSafe = (numerator: number, denominator: number): Result<number, Error> => {
    if (denominator === 0) {
        return Err(new Error("Cannot divide by zero."));
    }
    return Ok(numerator / denominator);
};

const result = divideSafe(10, 0);
result.caseOf({
    Err: err => console.error(err.message),
    Ok: value => console.log(value),
});

典型生态项目结合

虽然True Myth本身作为一个独立的库已经能够提供强大的类型安全处理能力，但在实际开发中，它常与其他现代JavaScript/TypeScript生态的工具结合使用，如React、Redux或是Node.js服务端。它不直接定义“典型生态项目”，但可以无缝集成到任何重视类型安全和函数式编程原则的项目中。

在React项目中，True Myth可以帮助开发者以函数式思维更安全地处理数据流，尤其是在处理来自用户的输入或不确定的API响应时。通过将True Myth与Redux结合，可以在状态管理中实现更为清晰和可靠的错误处理及空值管理策略。

请注意，具体结合实践将会依赖于你的技术栈细节和需求，True Myth的官方文档会提供进一步的集成说明和最佳实践指导。

true-mythA library for safer and smarter error- and "nothing"-handling in TypeScript.项目地址:https://gitcode.com/gh_mirrors/tr/true-myth