Skip to content

Commit

Permalink
fix(fmt): reformat README
Browse files Browse the repository at this point in the history
  • Loading branch information
josestg committed Nov 19, 2024
1 parent c1c0d6e commit c56f0e4
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Maybe - Safe Optional Values for TypeScript

`Maybe` is a utility for handling optional values safely and cleanly in TypeScript. Inspired by Haskell and OCaml, it provides a clear and functional approach to dealing with values that may or may not exist.
`Maybe` is a utility for handling optional values safely and cleanly in
TypeScript. Inspired by Haskell and OCaml, it provides a clear and functional
approach to dealing with values that may or may not exist.

## Features

- **Explicit Optional Values**: Use `Some` and `None` for clarity.
- **Functional API**: Transform and handle values with `map`, `flatMap`, and `match`.
- **Functional API**: Transform and handle values with `map`, `flatMap`, and
`match`.
- **Type-Safe**: Eliminate `null` and `undefined` errors.


## Example

```ts
Expand All @@ -29,4 +31,4 @@ const message = match(value, {
});

console.log(message); // "Value is 42"
```
```

0 comments on commit c56f0e4

Please sign in to comment.