*Copyright © 2026 Gage Sorrell.  Released under the [MIT license](./License.md).*

# `@sorrell/functional`

A small library of utilities for functional programming in TypeScript.

## Documentation

[The documentation is available here](https://functional.sorrell.sh), a subdomain of the author's personal website.

## Requirements

| Package      | Version     |
|-------------:|:------------|
| NodeJS       | `>=24.15.0` |
| `typescript` | `>=6.0.0`    |

## Installation

Once the [requirements](#requirements) are met, just install,

```bash
npm install @sorrell/functional
```

## Examples

### Currying

```typescript
// @TODO
```

## Related Resources

| Package | Description |
|--------:|:------------|
| [`@sorrell/pipe-operator`](https://github.com/GageSorrell/PipeOperator) | Overloaded `%` as the pipe operator. |
| [`@sorrell/utilities`](https://github.com/GageSorrell/SorrellWm/tree/Master/Package/Utilities) | General-purpose utilities. |
| [`@sorrell/cli-utilities`](https://github.com/GageSorrell/SorrellWm/tree/Master/Package/CliUtilities) | Utilities for CLI applications. |
| [`@sorrell/cli`](https://github.com/GageSorrell/SorrellWm/tree/Master/Package/Cli) | CLI to assist with TypeScript development. |