Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mobily/ts-belt

🔧 Fast, modern, and practical utility library for FP in TypeScript.
https://github.com/mobily/ts-belt

array flow fp functional-programming monad option option-type result result-type typescript

Last synced: about 1 month ago
JSON representation

🔧 Fast, modern, and practical utility library for FP in TypeScript.

Host: GitHub
URL: https://github.com/mobily/ts-belt
Owner: mobily
License: mit
Created: 2020-11-30T10:52:03.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-05-27T03:59:46.000Z (4 months ago)
Last Synced: 2024-07-18T15:49:18.942Z (2 months ago)
Topics: array, flow, fp, functional-programming, monad, option, option-type, result, result-type, typescript
Language: TypeScript
Homepage: https://mobily.github.io/ts-belt
Size: 16.2 MB
Stars: 1,070
Watchers: 12
Forks: 30
Open Issues: 50
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

jimsghstars - mobily/ts-belt - 🔧 Fast, modern, and practical utility library for FP in TypeScript. (TypeScript)

README

        


  





  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  





  Fast, modern, and practical utility library for FP in TypeScript.



## Documentation

Full documentation can be found [here](https://mobily.github.io/ts-belt/).

## Features

- 🚀 built with `ReScript`, which generates highly performant JavaScript code (see the benchmark results [here](https://mobily.github.io/ts-belt/benchmarks/introduction))

- 👀 provides more readable code, due to the `data-first` approach

- ✨ supports `TypeScript` and `Flow`

- 🛡 helps you write safer code with `Option` and `Result` types

- 🎯 all functions return immutable data (no side-effects)

- 🌲 tree-shakeable

- 📝 fully documented

## Getting started

### Installation

```shell

yarn add @mobily/ts-belt

```

or with `npm`

```shell

npm install @mobily/ts-belt --save

```

### Usage

| Module | Namespace | Description |

|--|-----------|--|

| [Array](https://mobily.github.io/ts-belt/api/array) | A | Utility functions for `Array`. |

| [Boolean](https://mobily.github.io/ts-belt/api/boolean) | B | Utility functions for `Boolean`. |

| [Number](https://mobily.github.io/ts-belt/api/number) | N | Utility functions for `Number`. |

| [Object (Dict)](https://mobily.github.io/ts-belt/api/object) | D | Utility functions for `Object`. |

| [String](https://mobily.github.io/ts-belt/api/string) | S | Utility functions for `String`. |

| [Guards](https://mobily.github.io/ts-belt/api/guards) | G | Various TypeScript guards. |

| [Option](https://mobily.github.io/ts-belt/api/option) | O | Functions for handling the `Option` data type that represents the existence and nonexistence of a value. |

| [Result](https://mobily.github.io/ts-belt/api/result) | R | Functions for describing the result of a certain operation without relying on exceptions. |

| [Function](https://mobily.github.io/ts-belt/api/function) | F | Other useful functions. |

```typescript

import { A, O, N, pipe } from '@mobily/ts-belt'

pipe(

  [1, 2, 3, 4, 5], // → [1, 2, 3, 4, 5]

  A.dropExactly(2), // → Some([3, 4, 5])

  O.flatMap(A.head), // → Some(3)

  O.map(N.multiply(10)), // → Some(30)

  O.getWithDefault(0), // → 30

) // → 30

```

## Contributors

  

    
_{Marcin Dziewulski}
💻 📖 ⚠️ 🎨 🚧

    
_{Krzysztof Lenda}
📖

    
_{Radek Kozieł}
📖

    
_Artur
📖

    
_{Dominik Łopaciński}
💻 📖 ⚠️

    
_{Jakub Wąsik}
📖

    
_{Krystian Mateusiak}
💻 📖 ⚠️

  

  

    
_{Michał Miszczyszyn}
🤔

    
_Kevin
📖

    
_{Anthony Khong}
💻 📖 ⚠️

    
_Pyrolistical
📖 🚧 🤔

    
_{Mathieu Acthernoene}
🤔

  

## License

The MIT License.

See [LICENSE](LICENSE)