@deessejs/fp (英语)

轻量级,TypeScript的型式安全功能编程工具. 成果,也许,尝试,单位,和朋友——只针对无害环境管理,不依赖运行时间,为一等互操作性设计 @ deessejs/ errors (英语)。 。 。 .

兄弟姐妹项目: @deessejs/errors 提供本地集成错误类型 @deessejs/fp是因为 Result 财务报告和审定财务报表 Try。将它们安装在一起,以获得一个没有胶水代码的完整错误处理故事. 内部使用 时间 deessejs.com (英语)。 。 。 .

包括什么

为什么是这堆

• 默认很简单. 没有过度工程, 没有花花公子类型的体操。 只是原始人 你需要写干净的代码.
• 仅限无害环境管理. 现代包装,没有CJS shim,没有 module编号 :main 重叠.
• 零运行时间依赖关系. 唯一的对等数据是 @deessejs/errors,这是选入。 图书馆本身是无依赖的.
• TypeScript 6 头等舱. 严格类型, 不 any 出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出入出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出入出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出出 仅凭类型是不够的.
• Lockfile - clean pnpm 工作空间. 单人 pnpm install 重建 涂料 类型 测试整个单体.
• 真正的测试. 测试,包括覆盖和整合测试 @ deessejs/ errors (英语)。 。 。 .

快开始

先决条件

• 节点.js 22.14.0+ (中文(简体) ) (单位:千美元)engines.node (已执行)
• 小时 10岁以上 联合国corepack enable 如果未安装)
• 类型脚本 6+ 时间 供消费者使用(软件包输出) dist/*.d.ts(中文(简体) )

安装

# Install @deessejs/fp with its optional sibling, @deessejs/errors.
# See https://github.com/deessejs/errors
npm install @deessejs/fp @deessejs/errors

@deessejs/errors 是可选的——如果需要安装 Result<T, E> ,可以将键入错误而不是字符串.

使用量

import { ok, err, some, none, maybe, pipe } from '@deessejs/fp';

// Result: represent values that may have failed
const divide = (a: number, b: number) => (b === 0 ? err('Division by zero') : ok(a / b));

const result = divide(10, 2);
result.match({
  ok: (value) => console.log(`Result: ${value}`),
  err: (error) => console.error(`Error: ${error}`),
});

// Maybe: represent optional values
const user = { name: 'Alice', address: { city: 'Paris' } };
const city = maybe(user.address?.city)
  .map((c) => c.toUpperCase())
  .getOrElse('Unknown');

// pipe: compose functions without glue
const trim = (s: string) => s.trim();
const uppercase = (s: string) => s.toUpperCase();
const processed = pipe('  hello  ', trim, uppercase);

引擎兼容性

仅限无害环境管理。 使用 CJS 解析器的消费者需要使用动态 import() 或迁移到无害环境管理.

可用命令

工作空间( 根)

软件包 : @deessejs/fp

应用 : web

兼容性

同伴依赖关系

发动机

项目结构

.
├── packages/
│   └── fp/                # The library — @deessejs/fp on npm
│       ├── src/           # Source code (ESM)
│       ├── dist/          # Build output (gitignored)
│       ├── vitest.config.ts
│       └── tsconfig.build.json
├── apps/
│   └── web/               # Documentation site (Next.js + Fumadocs)
├── docs/
│   ├── internal/          # Engineering plans, runbooks
│   │   ├── product/
│   │   └── versions/
│   └── AGENTS.md          # Agent guidance (CLAUDE.md redirects here)
├── pnpm-workspace.yaml
├── turbo.json             # Turborepo pipelines
├── .changeset/            # Changesets for versioning
└── README.md

出版

发行版通过Refersets + npm Trusted Publishing(OIDC)实现全自动化. 没有长寿 NPM_TOKEN 需要时间.

关于管道的全部设计,见 docs/engineering/plans/release-pipeline.md。 。 。 .

结构说明

• 仅限无害环境管理. 软件包导出ES模块. 消费者使用遗留的 CJS 解析器必须使用动态 import()。 。 。 .
• 严格的类型. Result.match 要求两个分支; Maybe.getOrElse 需要一个倒计时。 没有部分类型的出逃.
• 组成优先于继承. 所有原始人通过 pipe 财务报告和审定财务报表 flow没有阶级等级,没有 extends。 。 。 .
• 零跑时间抽象. 没有装饰,没有反射,没有代理陷阱. DevTools 和 node --prof。 。 。 .
• 出版前经过烟雾测试. 发布工作流程对已建成的文物进行动态的无害环境管理进口,并核实存在关键出口。 一个已断开的构建在到达 npm 之前失败了发布步骤 .
• @deessejs/errors 选择进入. 同龄人可以选择 消费者可以选择 @deessejs/fp 被隔离。 一次 @deessejs/errors 添加,每个 err(error) 调用接受打出错误.
• 认证式错误的真相来源. 这个 apps/app/proxy.ts (在更广泛的deessejs monorepo中,而不是在这个repo中)在代理级别执行电子邮件验证. @ deessejs/ errors (英语) 错误被捕获并翻译为集中的 HTTP 响应 .

捐款

打开一个问题来讨论更大的变化. 对于打字,断开的链接和小修正,公关是受欢迎的.

在提交公关前:

1. 运行 pnpm --filter @deessejs/fp test:run 财务报告和审定财务报表 pnpm --filter @deessejs/fp lint。 。 。 .
2. 添加一个 .changeset/<topic>.md 如果更改是用户化的(patch / small / major) .
3. 更新 docs/internal/product/README.md 如果 API 表面改变.

许可证

麻省理工学院。详情见LICENSE文件.

支助

• 问题: github.com/deessejs/fp/问题
• 讨论: github.com/deessejs/fp/讨论
• 电子邮件 : 支持@deessejs.com
• 联合国 fp.deessejs.com (中文(简体) )