refactor: rename caseOf() to match()

BREAKING CHANGE: rename caseOf() to match() for Either and Maybe monads

Author: patrickmichalina

README.md

@@ -49,15 +49,15 @@ import { maybe } from 'typescript-monads'
 let maybeVisitedBeforeXTimes: number | undefined = 50
 
 const priceWithDiscountForLoyalty = maybe(maybeVisitedBeforeXTimes)
-  .caseOf({
+  .match({
     some: visits => 15.00 - visits * 0.1,
     none: () => 15.00
   })
 
 // handle multiple maybe conditionas together
 const canRideCoaster = getAge() // Maybe<number>
   .bind(age => getTicket(age)) // Maybe<Ticket>
-  .caseOf({
+  .match({
     some: ticket => ticket.canRide('coaster1'),
     none: () => false
   })

src/either.ts

@@ -1,7 +1,7 @@
 export interface IEither<L, R> {
   isLeft(): boolean
   isRight(): boolean
-  caseOf<T>(pattern: IEitherPattern<L, R, T>): T
+  match<T>(pattern: IEitherPattern<L, R, T>): T
   map<T>(f: (r: R) => T): IEither<L, T>
   flatMap<T>(f: (r: R) => IEither<L, T>): IEither<L, T>
 }
@@ -44,7 +44,7 @@ export function either<L, R>(left?: L, right?: R): IEither<L, R> {
     isRight() {
       return exists(right)
     },
-    caseOf<T>(pattern: IEitherPattern<L, R, T>) {
+    match<T>(pattern: IEitherPattern<L, R, T>) {
       return exists(right)
         ? pattern.right(right as R)
         : pattern.left(left as L)

src/maybe.ts

@@ -37,7 +37,7 @@ export interface IMaybe<T> extends IMonad<T> {
   /**
    * Unwrap and apply MaybePattern functions
    */
-  caseOf<R>(pattern: IMaybePattern<T, R>): R
+  match<R>(pattern: IMaybePattern<T, R>): R
 
   /**
    * Combine multiple maybe
@@ -59,7 +59,7 @@ export function maybe<T>(value?: T): IMaybe<T> {
     valueOr: (val: T) => value === null || value === undefined ? val : value,
     valueOrCompute: (f: () => T) => value === null || value === undefined ? f() : value,
     tap: (obj: IMaybePattern<T, void>) => value === null || value === undefined ? obj.none() : obj.some(value),
-    caseOf: <R>(pattern: IMaybePattern<T, R>) => value === null || value === undefined ? pattern.none() : pattern.some(value),
+    match: <R>(pattern: IMaybePattern<T, R>) => value === null || value === undefined ? pattern.none() : pattern.some(value),
     map: <R>(f: (t: T) => R) => value === null || value === undefined ? maybe<R>() : maybe<R>(f(value)),
     flatMap: <R>(f: (d: T) => IMaybe<R>) => value === null || value === undefined ? maybe<R>() : f(value)
   }

test/either.spec.ts

@@ -34,27 +34,27 @@ describe('Either', () => {
     expect(eitherThing.isLeft()).toBeFalsy()
   })
 
-  it('should map to caseOf right side', () => {
+  it('should map to match right side', () => {
     const leftInput: number | undefined = undefined
     const rightInput = 'tester'
 
     const eitherThing = either(leftInput, rightInput)
 
-    const mapped = eitherThing.caseOf({
+    const mapped = eitherThing.match({
       left: num => '123',
       right: str => `${str}_right`
     })
 
     expect(mapped).toEqual('tester_right')
   })
 
-  it('should map to caseOf left side', () => {
+  it('should map to match left side', () => {
     const leftInput = 123
     const rightInput: string | undefined = undefined
 
     const eitherThing = either(leftInput, rightInput)
 
-    const mapped = eitherThing.caseOf({
+    const mapped = eitherThing.match({
       left: num => `${num}_left`,
       right: str => `${str}_right`
     })
@@ -71,7 +71,7 @@ describe('Either', () => {
 
     const mapped = eitherThing
       .map(rightNum => rightNum + 12)
-      .caseOf({
+      .match({
         left: () => 3,
         right: num => num
       })
@@ -80,7 +80,7 @@ describe('Either', () => {
 
     const mapped2 = eitherThing2
       .map(rightNum => rightNum + 12)
-      .caseOf({
+      .match({
         left: () => 3,
         right: num => num
       })
@@ -96,7 +96,7 @@ describe('Either', () => {
 
     const mapped = eitherThing
       .flatMap(rightNum => either(rightNum, input2))
-      .caseOf({
+      .match({
         left: () => 3,
         right: num => num
       })
@@ -112,7 +112,7 @@ describe('Either', () => {
 
     const mapped = eitherThing
       .flatMap(rightNum => either(rightNum, input2))
-      .caseOf({
+      .match({
         left: () => 3,
         right: num => num
       })

test/maybe.spec.ts

@@ -75,11 +75,11 @@ describe('Maybe', () => {
     })
   })
 
-  describe('when returning from a caseOf operation', () => {
+  describe('when returning from a match operation', () => {
     it('should handle "none" case', () => {
       const sut: string | undefined = undefined
       const maybeAMappedString = maybe(sut)
-        .caseOf({
+        .match({
           none: () => 'fallback',
           some: _original => _original
         })
@@ -90,7 +90,7 @@ describe('Maybe', () => {
     it('should handle "some" case', () => {
       const sut: string | undefined = 'existing value'
       const maybeAMappedString = maybe(sut)
-        .caseOf({
+        .match({
           none: () => 'fallback',
           some: _original => _original
         })