minifunc ⚜️

An extremely simple, small & type-safe functional programming library for TypeScript/JavaScript. - docs

heavily inspired by the rust programming language: https://rust-lang.org

Installation

You can use your favorite package manager to install minifunc via npmjs.org packages. For example:

$ bun install minifunc

Features

• Option<T>: A type that represents an optional value: every Option<T> is either Some(T) or None.
• Result<T, E>: A type that represents either success (Ok(T)) or failure (Err(E)).

Usage

The documentation is available here.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. If using bun, you can run tests with bun test. Most of the work is automated by husky (with the pre-comit hook) that you can install with bun run prepare or npm run prepare. Please make sure to update tests as appropriate.

This project uses prettier for code formatting and biomejs for linting. Both have their respective scripts in package.json. For versioning, follow the Semantic Versioning guidelines.

Although optional, it is recommended to use gitmoji (https://gitmoji.carloscuesta.me/) or cm (https://github.com/Brian3647/cm) for commit messages.

License

This project is licensed under the MIT License - see the LICENSE file for details