Releases: ideas2codedev/node-toonfile
Releases · ideas2codedev/node-toonfile
v1.0.0 - Initial Release
toonfile v1.0.0 - Initial Release 🎉
The first stable release of toonfile - A Node.js library for reading/writing TOON (Token-Oriented Object
Notation) files.
🌟 Features
- ✅ Simple API - Just like
jsonfile, but for TOON format - ✅ TypeScript Native - Written in TypeScript with full type definitions
- ✅ Dual API - Supports both callbacks and promises
- ✅ Cross-platform - Works on Windows, macOS, and Linux
- ✅ Token Efficient - Reduce LLM prompt tokens by 30-60% vs JSON
- ✅ Well Tested - 50 comprehensive tests, 100% passing
📦 Installation
npm install toonfile
🚀 Quick Start
const toonfile = require('toonfile')
// Read TOON file
const config = await toonfile.readFile('./config.toon')
// Write TOON file
const data = { name: 'Alice', scores: [95, 87, 92] }
await toonfile.writeFile('./output.toon', data)
📚 API
- readFile(file, [options], [callback]) - Read and parse TOON file
- readFileSync(file, [options]) - Synchronous read
- writeFile(file, obj, [options], [callback]) - Write object to TOON file
- writeFileSync(file, obj, [options]) - Synchronous write
- parse(toonString, [options]) - Parse TOON string
- stringify(obj, [options]) - Convert object to TOON string
📄 What's Included
- Full TypeScript source code (src/)
- Compiled JavaScript + type declarations (dist/)
- Comprehensive test suite (test/)
- Complete documentation (README.md)
🔗 Links
- npm Package: https://www.npmjs.com/package/toonfile
- Documentation: https://github.com/ideas2codedev/node-toonfile#readme
- Issues: https://github.com/ideas2codedev/node-toonfile/issues
- TOON Specification: https://github.com/toon-format/spec
📊 Stats
- Package size: ~15 KB (compressed)
- Dependencies: 1 (universalify)
- Node.js: >=14
- License: MIT
---
Full Changelog: https://github.com/ideas2codedev/node-toonfile/blob/main/CHANGELOG.md