Skip to content

Commit

Permalink
Revamp list of benefits in README
Browse files Browse the repository at this point in the history
  • Loading branch information
gustavoguichard committed May 23, 2024
1 parent 6343eb2 commit 5054a67
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@

A set of types and functions to make compositions easy and safe.

- 🛟 Type-safe compositions of functions
- 🧠 Always unwrap promises and errors as default
- 😣 Get rid of the terrible try/catch syntax
- ✅ End-to-end type safety, all the way from the Backend to the UI
- 🏝️ Isolate your business logic making it easier to test and maintain
- 📝 Allows business logic to be expressed in the type system
- 🛟 Type-Safe Compositions: Ensure robust type-safety during function composition, preventing incompatible functions from being combined and reducing runtime errors.
- 🔄 Promise and Error Handling: Focus on the happy-path of your functions eliminating the need for verbose try/catch syntax.
- 🏝️ Isolated Business Logic: Split your code into composable functions, making your code easier to test and maintain.
- 🔒 End-to-End Type Safety: Achieve end-to-end type safety from the backend to the UI with serializable results, ensuring data integrity across your entire application.
- ⚡ Parallel and Sequential Compositions: Compose functions both in parallel - with `all` and `collect` - and sequentially - with `pipe`, `branch`, and `sequence` -, to manage complex data flows optimizing your code for performance and clarity.
- 🕵️‍♂️ Runtime Validation: Use `withSchema` or `applySchema` with your favorite parser for optional runtime validation of inputs and environments, enforcing data integrity only when needed.
- 🚑 Resilient Error Handling: Leverage enhanced combinators like `mapErrors` and `catchFailure` to transform and handle errors more effectively.
- 📊 Traceable Compositions: Use the `trace` function to log and monitor your composable functions’ inputs and results, simplifying debugging and monitoring.

#### Go to [API Reference](./API.md)

Expand Down

0 comments on commit 5054a67

Please sign in to comment.