Ramda 中文

一款实用的 JavaScript 函数式编程库。

Build Status Test Coverage npm module deno land nest badge Gitter

Why Ramda?

目前已经存在许多优秀的函数式的库。通常它们作为通用工具包,可以用于多种编程范式。Ramda 的目标更为专注:专门为函数式编程风格而设计,更容易创建函数式 pipeline、且从不改变用户已有数据。

What's Different?

Ramda 主要特性如下:

最后两点一起,使得将多个函数构建为简单的函数序列变得非常容易,每个函数对数据进行变换并将结果传递给下一个函数。Ramda 的设计能很好地支持这种风格的编程。

简介

理念

使用 Ramda 时,应该感觉像使用原生 JavaScript 一样,它是实用且函数式的 JavaScript。Ramda 没有在字符串中引入 lambda 表达式,也没有借用 consed 列表,更不是要移植所有的 Clojure 函数。

Ramda 基本的数据结构都是原生 JavaScript 对象,我们常用的集合是 JavaScript 的数组。Ramda 还保留了许多其他原生 JavaScript 特性,例如,函数是具有属性的对象。

函数式编程优势主要体现在数据不变性和函数无副作用两方面。虽然 Ramda 没有对此特别加强,但它在这两方面支持的非常好。

我们尽量让实现(编程和 API 实现)简洁、优雅。但 API 为王。为此我们牺牲了大量优雅、简洁的实现。

最后,Ramda 非常注重运行性能。可靠和快速的实现胜过过于强调函数式的纯度。(译者注:Eweda 过于在意实现的函数式纯度,而失去了实用价值)

安装

使用 node:

$ npm install ramda

然后在 console 中使用:

const R = require('ramda');

To use directly in Deno:

import * as R from "https://deno.land/x/ramda@v0.27.2/mod.ts";

or using Nest.land:

import * as R from "https://x.nest.land/ramda@0.27.2/mod.ts";

直接在浏览器中使用:

<script src="path/to/yourCopyOf/ramda.js"></script>

或使用最小化版本:

<script src="path/to/yourCopyOf/ramda.min.js"></script>

或从 CDN 上获取:

<script src="//cdnjs.cloudflare.com/ajax/libs/ramda/0.26.0/ramda.min.js"></script>

或使用 jsDelivr 的以下任意链接:

<script src="//cdn.jsdelivr.net/npm/ramda@0.26.0/dist/ramda.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/ramda@0.26/dist/ramda.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/ramda@latest/dist/ramda.min.js"></script>

(注意,使用 最新 的版本可能会带来很大的风险,ramda API 的更改可能会对以前代码造成破坏)

这些脚本标签会在浏览器中添加一个全局变量 R

或者也可以借助 the bookmarklet,将 ramda 注入到几乎任何不安全的网站。

0.25 及以后版本注意事项

Ramda 在 0.25 以后,不会再提供默认输出(default export)。所以不要再用 import R from 'ramda',而应该使用 import * as R from 'ramda' 引入 ramda。或者更好的方式是,通过 import { functionName } from 'ramda' 只引入必需的函数。

ES6 模块和浏览器注意事项

为了在浏览器中访问 ES6 模块, 必须提供 es 目录内容 (请参考下面的构建说明) 并使用 import * as R from './node_modules/ramda/es/index.js';

Build (构建)

运行 npm run build 会生成 essrc 文件夹,并更新 dist/ramda.jsdist/ramda.min.js

Partial Build (部分构建库 )

若想减小库大小,可以只使用部分函数来构建 Ramda 。Ramda 的构建系统使用命令行参数来支持部分构建。例如,当使用 R.compose, R.reduce, and R.filter 时,可以创建一个部分构建库:

npm run --silent partial-build compose reduce filter > dist/ramda.custom.js

上述命令需要安装 Node/io.js 和 ramda 的依赖(只需在部分构建开始前运行 npm install)。

下载单个的函数

通过 bit 下载单个的函数,而不需要通过 npm 和 yarn 去下载整个库

文档

请查看 API 文档.

也可以使用 Cookbook 中的由 Ramda 构建的函数。

关于名字

好吧,因为我们喜欢羊,就是这样。名字要简洁、且未被占用。它可以是 eweda,然后我们被迫叫它 eweda lamb! ,但没有人想要这个名字。对于非英语国家的人,lambs 是羔羊,ewes 是母羊,rams 是公羊。所以 ramda 可能是一只成年的 lambda ...,也可能不是。(双关,既代表 lambda 表示式,也代表羔羊。愿 Ramda 发展壮大)

运行测试套件

控制台(Console):

要从控制台运行测试套件,需要安装 mocha

npm install -g mocha

然后在项目根目录下调用:

mocha

或者,如果已安装依赖:

npm install

那么便可以运行测试(并获得详细的输出):

npm test

浏览器(Browser):

在浏览器中运行测试套件,只需打开 test/index.html

或者,可以使用 testem 在不同的浏览器(甚至是无界面浏览器)上测试,也可以使用测试的实时重载特性。 安装 testem (npm install -g testem)并运行。 打开浏览器中提供的链接,将会在终端中看到结果。

如果已安装 PhantomJS ,则可以运行 testem -l phantomjs ,以完全无界面方式运行测试。

使用

对于 v0.25 及更高版本,可以导入整个库,或直接从库中选择 ES 模块:

import * as R from 'ramda'

const {identity} = R
R.map(identity, [1, 2, 3])

利用解构导入 ramda 函数可能并不能阻止引入整个库。可以像下面这样手动挑选函数,只会引入 identity 运行所需的部分:

import identity from 'ramda/src/identity'

identity()

但手动引入函数太麻烦。大多数 bundlers (Webpack 和 Rollup 一类的打包器) 都会提供 tree-shaking 方法,用以删除未用到的 Ramda 代码,并减小打出包的体积。但它们的实际效果各异,实际对比可以参考这里。下面列出了一些最佳设置总结:

  1. Webpack + Babel - 使用 babel-plugin-ramda 自动挑选函数。相关讨论相关实例

  2. 仅使用 Webpack - 使用 UglifyJS plugin 和 ModuleConcatenationPlugin 来进行 tree-shaking。相关讨论相关实例

  3. Rollup - 自身对 tree-shaking 支持的很好,不需要其他配置。相关实例

类型系统

翻译

Funding

If you wish to donate to Ramda please see our Open Collective page. Thank you!

致谢

感谢 J. C. Phillipps 为 Ramda 设计的标志。 Ramda 标志艺术品 © 2014 J. C. Phillipps 。 创作共享协议 CC BY-NC-SA 3.0

中文翻译

王增迪张聪杰张春晓陈申乾陈雪勇张大尉

如果发现翻译不恰当的地方,恳请指正。也欢迎加入我们,一起维护 Ramda 中文网站。

Ramda 企鹅讨论群

114706031

Hosted by Coding Pages