Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ordering matchW added #1535

Merged
merged 1 commit into from Apr 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/modules/Ordering.ts.md
Expand Up @@ -16,6 +16,7 @@ Added in v2.0.0
- [reverse](#reverse)
- [destructors](#destructors)
- [match](#match)
- [matchW](#matchw)
- [instances](#instances)
- [Eq](#eq)
- [Monoid](#monoid)
Expand Down Expand Up @@ -55,6 +56,22 @@ export declare const match: <A>(onLessThan: () => A, onEqual: () => A, onGreater

Added in v2.10.0

## matchW

Less strict version of [`match`](#match).

**Signature**

```ts
export declare const matchW: <A, B, C>(
onLessThan: () => A,
onEqual: () => B,
onGreaterThan: () => C
) => (o: Ordering) => A | B | C
```

Added in v2.11.0

# instances

## Eq
Expand Down
13 changes: 11 additions & 2 deletions src/Ordering.ts
Expand Up @@ -19,12 +19,21 @@ export type Ordering = -1 | 0 | 1
// destructors
// -------------------------------------------------------------------------------------

/**
* Less strict version of [`match`](#match).
*
* @category destructors
* @since 2.11.0
*/
export const matchW = <A, B, C>(onLessThan: () => A, onEqual: () => B, onGreaterThan: () => C) => (
o: Ordering
): A | B | C => (o === -1 ? onLessThan() : o === 0 ? onEqual() : onGreaterThan())

/**
* @category destructors
* @since 2.10.0
*/
export const match = <A>(onLessThan: () => A, onEqual: () => A, onGreaterThan: () => A) => (o: Ordering): A =>
o === -1 ? onLessThan() : o === 0 ? onEqual() : onGreaterThan()
export const match: <A>(onLessThan: () => A, onEqual: () => A, onGreaterThan: () => A) => (o: Ordering) => A = matchW

// -------------------------------------------------------------------------------------
// combinators
Expand Down