# toml-parser

**Repository Path**: lllgr/toml-parser

## Basic Information

- **Project Name**: toml-parser
- **Description**: TOML解析器，适用于ArkTS/HarmonyOS，支持所有TOML特性，包括嵌套表、数组表、多行数组和内联表。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-01
- **Last Updated**: 2025-08-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TOML Parser for ArkTS

一个专为ArkTS/HarmonyOS设计的TOML解析器，支持完整的TOML规范。

## ✨ 特性

- 🎯 完全类型安全
- 🚀 支持所有TOML特性
- 📝 详细的错误报告
- 🛠️ 实用的工具方法
- 📱 专为HarmonyOS优化

## 🚀 支持的TOML特性

- ✅ 基础数据类型（字符串、数字、布尔值、日期）
- ✅ 数组和多行数组
- ✅ 表和嵌套表
- ✅ 数组表和嵌套数组表
- ✅ 内联表和多行内联表
- ✅ 注释和多行字符串

## 📦 安装

`ohpm i @lllgr/toml-parser`   
OpenHarmony ohpm 环境配置等更多内容，请参考[如何安装 OpenHarmony ohpm 包](https://ohpm.openharmony.cn/#/cn/help/downloadandinstall)

## ⚡ 快速开始

```typescript
import Toml from '@lllgr/toml-parser';

const tomlContent = `
title = "我的应用"
[database]
host = "localhost"
port = 5432
`;

const config = Toml.parseSync(tomlContent);
const title = Toml.getValue(config, 'title');
const dbHost = Toml.getValue(config, 'database.host');

console.log(title, dbHost); // "我的应用" "localhost"
```

## 📚 API

```typescript
// 解析TOML字符串
const result = Toml.parse(tomlContent);

// 同步解析（抛出异常）
const config = Toml.parseSync(tomlContent);

// 获取嵌套值
const value = Toml.getValue(config, 'database.host');

// 设置嵌套值
Toml.setValue(config, 'new.key', 'value');

// 深度克隆
const cloned = Toml.clone(config);

// 合并对象
const merged = Toml.merge(config1, config2);
```

## 🔧 错误处理

```typescript
try {
  const config = Toml.parseSync(tomlContent);
  // 使用配置
} catch (error) {
  const err = error as TomlSyntaxError;
  console.error('TOML语法错误:', err.message);
  console.error('错误位置: 行', err.line, '列', err.column);
}
```

## 📄 许可证

Apache-2.0 License

---

**如果这个项目对你有帮助，请给个⭐️支持一下！**