Package Exports
- @sheetxl/formulas
Readme
@sheetxl/formulas
A modern, type-safe library of spreadsheet functions, ready for any JavaScript or TypeScript project.
@sheetxl/formulas is the official open-source function library for SheetXL.
It is designed to be robust, easy to use, and compatible with popular spreadsheet applications.
Our Philosophy
This library has a simple goal: to create a comprehensive set of spreadsheet functions written in TypeScript.
Our implementation is heavily inspired by and derived from the great work done on formulajs. We are deeply grateful for their contribution to the community and aim to build upon that foundation with a modern, type-safe architecture.
Our plan is to support the complete function sets of Microsoft Excel and Google Sheets, while also embracing new and useful functions suggested by the community.
Key Features
- Comprehensive: Growing support for Math, Text, Logical, Financial, and Lookup functions.
- TypeScript First: Written from the ground up in TypeScript for robust type safety.
- Vector Optimized: Functions are designed to leverage the vector API of
@sheetxl/primitives, allowing them to efficiently operate on ranges of data (IRange), not just single values. - Engine-Agnostic & Lightweight: A simple TypeScript API with no spreadsheet engine dependency. Its only core dependency is
@sheetxl/primitives. - Permissively Licensed: Free to use for any project under the MIT license.
Installation
# Using npm
npm install @sheetxl/formulas @sheetxl/primitives
# Using pnpm
pnpm add @sheetxl/formulas @sheetxl/primitivesFull list of Excel functions
🔗 Learn More
Whether you're ready to build, need help, or just want to see more examples, here's where to go next.
- 💬 Join our Discord Community - Get help and connect with the team.
- ⭐ Star us on GitHub - If you like SheetXL give us a star ⭐ and help others find us!
- 📘 Developer Docs - Guides and tutorials.
- 🔌 API Reference - Detailed documentation for all packages.
- 👀 Live Demo Gallery - A showcase of interactive examples.
- 🖼️ Storybook - Explore and test individual UI components.
- 🌐 Website - Our Website.