json-bigint 技术文档

安装指南

你可以通过npm轻松地安装json-bigint：

npm install json-bigint --save

这会将模块下载到你的项目的依赖列表中，并准备好在你的项目中使用。

项目使用说明

json-bigint扩展了标准的JSON处理能力，以支持大整数。下面是如何在你的代码中应用它的基本步骤：

// 引入json-bigint模块
var JSONbig = require('json-bigint');

// 解析包含大整数的JSON字符串
var json = '{ "largeId": 9223372036854775807 }';
var parsedJson = JSONbig.parse(json);

console.log(parsedJson.largeId); // 输出将是正确的大整数值，而不是经过浮点运算后的近似值

// 序列化回JSON时同样保持大整数特性
var jsonStringified = JSONbig.stringify(parsedJson);
console.log(jsonStringified); // 确保大整数被正确序列化

项目API使用文档

主要API

• JSONbig.parse(jsonString[, options]): 解析JSON字符串，其中的大整数将以BigInt形式保存。
• JSONbig.stringify(obj[, spaces]): 将对象序列化成JSON字符串，保证BigInt被正确处理。

配置选项(options)

• options.strict: 默认false，设置为true后，将在解析时严格检查重复的键，导致错误而非覆盖。
• options.storeAsString: 默认false，当设置为true时，大整数被存储为字符串而不是BigInt或BigNumber对象。
• options.useNativeBigInt: 默认false，使用原生的BigInt而非bignumber.js库。
• options.alwaysParseAsBig: 默认false，强制所有数字解析为BigNumber，即使它们在范围内不会引起溢出。
• options.protoAction 和 options.constructorAction: 控制__proto__和constructor属性的处理方式，默认是抛出错误，可设为ignore或preserve。

示例

启用严格的键检查并使用原生BigInt:

var JSONbigStrictNative = require('json-bigint')({ strict: true, useNativeBigInt: true });

项目安装方式回顾

再次强调，安装json-bigint的命令为：

npm install json-bigint --save

这个命令确保了你在开发过程中能访问该库，并将其记录在你的package.json文件中作为依赖项。

注意事项

在处理大整数的JSON串时，需要注意序列化与反序列化过程中的数据类型转换，特别是在使用storeAsString或默认情况下，确保理解其对于后续计算的影响。

通过以上指南，你应该能够熟练地在需要处理大整数的JavaScript项目中集成和使用json-bigint库了。