# toon-codec 🚀

A lightweight, high-performance Node.js utility to convert JSON payloads into **Token-Oriented Object Notation (TOON)**. 

TOON is a data format specifically optimized for Large Language Models (LLMs), designed to reduce token consumption by **30-60%** while maintaining the structural integrity of your data.

---

## 📦 Installation

Install the package via npm:

```bash
npm install toon-codec

🛠 Usage Examples

1. Simple Object (Easy)

Ideal for basic key-value pairs where quotes and braces are removed to save tokens.

const { jsonToToon } = require('toon-codec');

const simpleData = {
  status: "success",
  code: 200,
  message: "Data retrieved"
};

console.log(jsonToToon(simpleData));

Output:

status: success
code: 200
message: Data retrieved

2. Tabular List (Medium)

The codec automatically detects uniform arrays to create a compact table, removing repetitive keys to maximize efficiency.

const { jsonToToon } = require('toon-codec');

const userData = {
  users: [
    { id: 101, name: "Devang", role: "Admin" },
    { id: 102, name: "Alice", role: "Developer" }
  ]
};

console.log(jsonToToon(userData));

Output:

users:
  [2]{id,name,role}:
    101,Devang,Admin
    102,Alice,Developer

3. Complex Nested Structure (Hard)

Demonstrates how the codec handles deeply nested objects, mixed arrays, and different data types simultaneously.

const { jsonToToon } = require('toon-codec');

const projectData = {
  projectName: "AI-Optimizer",
  metadata: {
    version: "1.0.3",
    tags: ["node", "ai"]
  },
  logs: [
    { timestamp: "2026-02-01", level: "INFO", msg: "Service Started" },
    { timestamp: "2026-02-01", level: "WARN", msg: "High Memory Usage" }
  ]
};

console.log(jsonToToon(projectData));

Output:

projectName: AI-Optimizer
metadata:
  version: 1.0.3
  tags:
    [2]:
      - node
      - ai
logs:
  [2]{timestamp,level,msg}:
    2026-02-01,INFO,Service Started
    2026-02-01,WARN,High Memory Usage

✨ Features

• Token Efficiency: Replaces heavy JSON syntax with clean indentation and tabular headers.
• Tabular Optimization: Automatically detects uniform arrays for row-based compression.
• Zero Dependencies: Extremely small footprint for your Node.js environment.
• TypeScript Support: Full type definitions included out of the box.

📖 API Reference

jsonToToon(data)

• data: Object | Array - The JSON-compatible data you want to convert.
• returns: string - The formatted TOON string.

📜 License

MIT © 2026 Devang Patel

### Steps to push the visual update:
1.  **Save** the code above into your `README.md` file.
2.  **Update Version**: Change the version in your `package.json` to `1.0.3`.
3.  **Publish**: Run `npm publish` in your terminal. 

This format uses horizontal rules (`---`) and emoji headers to create a "card-like" visual separation on the NPM page.