# json-stable-stringify-without-jsonify 中文文档

规范地址：https://npmcn.com/package/json-stable-stringify-without-jsonify/

版本：1\.0\.1
npm 元数据更新时间：2023-06-22T16:32:42.071Z
中文译文更新时间：2026-11-05T01:43:26.822Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/json-stable-stringify-without-jsonify
原文对照：https://npmcn.com/package/json-stable-stringify-without-jsonify/?lang=original
项目主页：https://github.com/samn/json-stable-stringify
源码仓库：https://github.com/samn/json-stable-stringify

## 关键信息（来自 npm 元数据）

- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2016-12-15T22:00:35.805Z
- 最新版本发布：2016-12-15T22:00:35.805Z
- 近 30 天下载量：546460943（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

具有自定义排序的JSON.stringify()，从字符串化的结果中获得确定性哈希，没有公共领域依赖关系

## 安装

```sh
npm install json-stable-stringify-without-jsonify
```

也可以使用：`pnpm add json-stable-stringify-without-jsonify`、`yarn add json-stable-stringify-without-jsonify`、`bun add json-stable-stringify-without-jsonify`

## README

# json-stable-stringify

这和 [https://github.com/substack/json-stable-stringify](https://github.com/substack/json-stable-stringify) 但它不依赖于没有许可证的库（jsonify）。

的确定性版本 `JSON.stringify()` 所以你可以得到一个一致的哈希 从字符串化的结果

您还可以传入一个自定义比较函数。

[![browser support](https://ci.testling.com/substack/json-stable-stringify.png)](https://ci.testling.com/substack/json-stable-stringify)

[![build status](https://secure.travis-ci.org/substack/json-stable-stringify.png)](http://travis-ci.org/substack/json-stable-stringify)

# 例子

```js
var stringify = require('json-stable-stringify');
var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 };
console.log(stringify(obj));
```

输出：

```
{"a":3,"b":[{"x":4,"y":5,"z":6},7],"c":8}
```

# 方法

```js
var stringify = require('json-stable-stringify')
```

## Var STR = stringify（obj, options）

返回一个确定的字符串化字符串 `str` 从物体 `obj`。

## 选项

### cmp

如果 `opts` 是给定的，你可以提供一个 `opts.cmp` 进行自定义比较 对象键的函数。你的函数 `opts.cmp` 被称为 参数:

```js
opts.cmp({ key: akey, value: avalue }, { key: bkey, value: bvalue })
```

例如，要按反向顺序对对象键名进行排序，您可以这样写：

```js
var stringify = require('json-stable-stringify');

var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 };
var s = stringify(obj, function (a, b) {
    return a.key < b.key ? 1 : -1;
});
console.log(s);
```

其结果是输出字符串：

```
{"c":8,"b":[{"z":6,"y":5,"x":4},7],"a":3}
```

或者如果你想对对象的值反向排序，你可以这样写：

```
var stringify = require('json-stable-stringify');

var obj = { d: 6, c: 5, b: [{z:3,y:2,x:1},9], a: 10 };
var s = stringify(obj, function (a, b) {
    return a.value < b.value ? 1 : -1;
});
console.log(s);
```

输出:

```
{"d":6,"c":5,"b":[{"z":3,"y":2,"x":1},9],"a":10}
```

### 空间

如果你指定 `opts.space`，它将缩进输出以实现美观的打印。 有效值是字符串(例如： `{space: \t}`)或若干空格 （`{space: 3}`）.

例如:

```js
var obj = { b: 1, a: { foo: 'bar', and: [1, 2, 3] } };
var s = stringify(obj, { space: '  ' });
console.log(s);
```

输出:

```
{
  "a": {
    "and": [
      1,
      2,
      3
    ],
    "foo": "bar"
  },
  "b": 1
}
```

### 替代者

replacer参数是一个函数 `opts.replacer(key, value)` 这行为 与替换器相同 [从核心JSON对象](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_native_JSON#The_replacer_parameter)。

# 安装

与 [npm](https://npmjs.org/) 做的事:

```
npm install json-stable-stringify
```

# 许可证

麻省理工学院

## 常见问题

### json-stable-stringify-without-jsonify 是什么？

具有自定义排序的JSON\.stringify\(\)，从字符串化的结果中获得确定性哈希，没有公共领域依赖关系

### 如何安装 json-stable-stringify-without-jsonify？

在项目目录运行 npm install json-stable-stringify-without-jsonify，或使用 pnpm add / yarn add / bun add。

### json-stable-stringify-without-jsonify 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/json-stable-stringify-without-jsonify 是否存在。

### json-stable-stringify-without-jsonify 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### json-stable-stringify-without-jsonify 可以商用吗？

json-stable-stringify-without-jsonify 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### json-stable-stringify-without-jsonify 的下载量有多少？

根据 npm 官方下载统计，json-stable-stringify-without-jsonify 在 2026/10/05 – 2026/11/03 这 30 天内被下载 546,460,943 次，日均约 18,215,365 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### json-stable-stringify-without-jsonify 还在维护吗？

最新版本 1\.0\.1 发布于 2016/12/16（9 年前）；至今共发布 1 个版本，其中过去 12 个月发布了 0 个；首次发布于 2016/12/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。