INI 格式解析与序列化工具技术文档
2024-12-24 20:58:30作者:曹令琨Iris
1. 安装指南
环境要求
- Node.js 版本 >= 12.x
安装步骤
- 打开终端或命令行工具。
- 使用 npm 或 yarn 安装该工具:
npm install ini-parser-serializer
或
yarn add ini-parser-serializer
2. 项目使用说明
基本使用
该工具允许你读取、修改和写入 INI 格式的文件。以下是一个基本的使用示例:
import { writeFile, readFile } from 'node:fs/promises';
import { stringify, parse } from 'ini-parser-serializer';
// 读取 INI 文件
let text = await readFile('./Original.ini', {
encoding: 'utf-8'
});
// 解析文本数据为对象
const config = parse(text);
// 修改数据对象
config.scope = 'local';
config.database.database = 'use_another_database';
config.paths.default.tmpdir = '/tmp';
delete config.paths.default.datadir;
config.paths.default.array.push('fourth value');
// 将数据对象序列化为 INI 格式
text = stringify(config, {
section: 'section'
});
// 写入修改后的 INI 文件
await writeFile('./Modified.ini', text);
示例 INI 文件
; 这是一个被忽略的注释
scope = global
[database]
user = dbuser
password = dbpassword
database = use_this_database
[paths.default]
datadir = /var/lib/data
array[] = first value
array[] = second value
array[] = third value
修改后的 INI 文件
[section]
scope=local
[section.database]
user=dbuser
password=dbpassword
database=use_another_database
[section.paths.default]
tmpdir=/tmp
array[]=first value
array[]=second value
array[]=third value
array[]=fourth value
3. 项目 API 使用文档
parse
将给定的 INI 字符串转换为嵌套的数据对象。
const object = parse(`<INI Text>`);
stringify
将给定的数据对象编码为 INI 格式的字符串。
stringify(object, {
whitespace: false, // 是否在 `=` 前后插入空格
align: false, // 是否对齐 `=` 字符
section: 'section', // 全局项的标识符
sort: false, // 是否按字母顺序排序
newline: false, // 是否在每个节头后插入换行符
platform: 'win32', // 使用的换行符平台
bracketedArray: true // 是否在数组键后附加 `[]`
});
safe / unsafe
将给定的字符串转换为在 INI 文件中安全使用的键或值,或反向操作。
safe(`"unsafe string"`); // -> \"unsafe string\"
unsafe(`\\"safe string\\"`); // -> "safe string"
4. 项目安装方式
通过 npm 或 yarn 安装:
npm install ini-parser-serializer
或
yarn add ini-parser-serializer
安装完成后,你可以在项目中导入并使用该工具。
登录后查看全文
热门项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
最新内容推荐
昆仑通态MCGS与台达VFD-M变频器通讯程序详解:工业自动化控制完美解决方案 开源电子设计自动化利器:KiCad EDA全方位使用指南 Photoshop作业资源文件下载指南:全面提升设计学习效率的必备素材库 TextAnimator for Unity:打造专业级文字动画效果的终极解决方案 CrystalIndex资源文件管理系统:高效索引与文件管理的最佳实践指南 VSdebugChkMatch.exe:专业PDB签名匹配工具全面解析与使用指南 SteamVR 1.2.3 Unity插件:兼容Unity 2019及更低版本的VR开发终极解决方案 基于Matlab的等几何分析IGA软件包:工程计算与几何建模的完美融合 Launch4j中文版:Java应用程序打包成EXE的终极解决方案 中兴e读zedx.zed文档阅读器V4.11轻量版:专业通信设备文档阅读解决方案
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
249
2.48 K
deepin linux kernel
C
24
6
Ascend Extension for PyTorch
Python
90
119
暂无简介
Dart
548
119
React Native鸿蒙化仓库
JavaScript
217
298
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.02 K
600
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
592
126
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
411
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
356
1.75 K
openGauss kernel ~ openGauss is an open source relational database management system
C++
153
204