@sheetxl/formulas/README.md

Formulas - TypeScript formulas compatible with Excel built-ins.

# @sheetxl/formulas

<p align="center">
  <a href="https://www.sheetxl.com" target="_blank">
    <img src="https://www.sheetxl.com/logo-text.svg" alt="SheetXL Logo" width="180" />
  </a>
</p>

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](https://www.sheetxl.com).
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](https://formulajs.info/)**. 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

```bash
# Using npm
npm install @sheetxl/formulas @sheetxl/primitives

# Using pnpm
pnpm add @sheetxl/formulas @sheetxl/primitives
```

## Full list of Excel functions

https://support.office.com/en-us/article/excel-functions-by-category-5f91f4e9-7b42-46d2-9bd1-63f26a86c0eb

## 🔗 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](https://discord.gg/NTKdwUgK9p)** - Get help and connect with the team.
* ⭐ **[Star us on GitHub](https://github.com/sheetxl/sheetxl)** - If you like SheetXL give us a star ⭐ and help others find us!
* 📘 **[Developer Docs](https://www.sheetxl.com/docs)** - Guides and tutorials.
* 🔌 **[API Reference](https://api.sheetxl.com)** - Detailed documentation for all packages.
* 👀 **[Live Demo Gallery](https://www.sheetxl.com/demos)** - A showcase of interactive examples.
* 🖼️ **[Storybook](https://storybook.sheetxl.com)** - Explore and test individual UI components.
* 🌐 **[Website](https://www.sheetxl.com)** - Our Website.

---