Skip to content

Commit

Permalink
docs: improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
patrickap committed Mar 9, 2023
1 parent c7e6c94 commit 2ba63a7
Showing 1 changed file with 20 additions and 21 deletions.
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,39 +28,38 @@ npm install moneo-ts@x.x.x
```typescript
import { Option, Some, None } from 'moneo-ts';

Option(0); // -> Some<number>
Option(''); // -> Some<string>
Option({}); // -> Some<{}>
Option(null); // -> None
Option(undefined); // -> None
Option(0); // Some<number>
Option(''); // Some<string>
Option({}); // Some<{}>
Option(null); // None
Option(undefined); // None
```

**Either**

```typescript
import { Either, Right, Left } from 'moneo-ts';

Right(0); // -> Right<number>
Right(''); // -> Right<string>
Right({}); // -> Right<{}>
Right(null); // -> Right<null>
Right(undefined); // -> Right<undefined>

Left(0); // -> Left<number>
Left(''); // -> Left<string>
Left({}); // -> Left<{}>
Left(null); // -> Left<null>
Left(undefined); // -> Left<undefined>
Right(0); // Right<number>
Right(''); // Right<string>
Right({}); // Right<{}>
Right(null); // Right<null>
Right(undefined); // Right<undefined>

Left(0); // Left<number>
Left(''); // Left<string>
Left({}); // Left<{}>
Left(null); // Left<null>
Left(undefined); // Left<undefined>
```

**IO**

```typescript
import { IO, IOAsync } from 'moneo-ts';

// Examples
IO(() => 1); // -> IO<void, number>
IO((env: { a: 1 }) => env.a + 1); // -> IO<{ a: number }, number>
IOAsync(async () => 1); // -> IOAsync<void, number>
IOAsync(async (env: { a: 1 }) => env.a + 1); // -> IOAsync<{ a: number }, number>
IO(() => 1); // IO<void, number>
IO((env: { a: 1 }) => env.a + 1); // IO<{ a: number }, number>
IOAsync(async () => 1); // IOAsync<void, number>
IOAsync(async (env: { a: 1 }) => env.a + 1); // IOAsync<{ a: number }, number>
```

0 comments on commit 2ba63a7

Please sign in to comment.