refactor(qio): rename flattenM to tryM

affects: @qio/core, @qio/example BREAKING CHANGE: rename \`flattenM\` to \`tryM\`
tusharmath · Nov 25, 2019 · b5aa169 · b5aa169
1 parent 0d1d23d
commit b5aa169
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 29 deletions.
diff --git a/packages/core/__tests__/Program.test.ts b/packages/core/__tests__/Program.test.ts
@@ -22,7 +22,7 @@ describe('Program', () => {
 
     return {
       getStrLn: (question: string) =>
-        QIO.flattenM(() => {
+        QIO.tryM(() => {
           const popped = input.hasOwnProperty(question)
             ? input[question].shift()
             : undefined

diff --git a/packages/core/lib/main/Await.ts b/packages/core/lib/main/Await.ts
@@ -19,7 +19,7 @@ export class Await<A, E> {
   private readonly Q = DoublyLinkedList.of<[CB<A>, CB<E>]>()
   private result: Option<Either<E, A>> = Option.none()
   public get get(): QIO<A, E> {
-    return QIO.flattenM(() =>
+    return QIO.tryM(() =>
       this.result
         .map(S => S.reduce<QIO<A, E>>(QIO.reject, XX => QIO.resolve(XX)))
         .getOrElse(this.wait)
@@ -29,7 +29,7 @@ export class Await<A, E> {
     return QIO.lift(() => this.flag)
   }
   public set(io: QIO<A, E>): QIO<boolean> {
-    return QIO.flattenM(() => {
+    return QIO.tryM(() => {
       if (this.flag) {
         return QIO.resolve(false)
       }

diff --git a/packages/core/lib/main/QIO.ts b/packages/core/lib/main/QIO.ts
@@ -204,29 +204,6 @@ export class QIO<A1 = unknown, E1 = never, R1 = unknown> {
   ): QIO<A2, E1 | E2, R1 & R2> {
     return qio.chain(Id)
   }
-  /**
-   * Takes in a effect-ful function that return a c and unwraps it.
-   * This is an alias to `c.flatten(QIO.lift(fn))`
-   *
-   * ```ts
-   * // An impure function that creates mutable state but also returns a c.
-   * const FN = () => {
-   *   let count = 0
-   *
-   *   return c.try(() => count++)
-   * }
-   * // Using flatten
-   * c.flatten(QIO.lift(FN))
-   *
-   * // Using flattenM
-   * c.flattenM(FN)
-   * ```
-   */
-  public static flattenM<A1, E1, R1>(
-    qio: () => QIO<A1, E1, R1>
-  ): QIO<A1, E1, R1> {
-    return QIO.flatten(QIO.lift(qio))
-  }
   /**
    * Creates a new [[Fiber]] to run the given [[QIO]].
    */
@@ -430,6 +407,27 @@ export class QIO<A1 = unknown, E1 = never, R1 = unknown> {
   public static try<A>(cb: () => A): QIO<A, Error> {
     return QIO.lift(cb)
   }
+  /**
+   * Takes in a effect-ful function that return a c and unwraps it.
+   * This is an alias to `c.flatten(QIO.lift(fn))`
+   *
+   * ```ts
+   * // An impure function that creates mutable state but also returns a c.
+   * const FN = () => {
+   *   let count = 0
+   *
+   *   return c.try(() => count++)
+   * }
+   * // Using flatten
+   * c.flatten(QIO.lift(FN))
+   *
+   * // Using flattenM
+   * c.tryM(FN)
+   * ```
+   */
+  public static tryM<A1, E1, R1>(qio: () => QIO<A1, E1, R1>): QIO<A1, E1, R1> {
+    return QIO.flatten(QIO.lift(qio))
+  }
   /**
    * Tries to run an function that returns a promise.
    */

diff --git a/packages/core/lib/main/Queue.ts b/packages/core/lib/main/Queue.ts
@@ -23,7 +23,7 @@ export class Queue<A = never> {
    * Pulls an item from the queue
    */
   public get take(): QIO<A> {
-    return QIO.flattenM(() => {
+    return QIO.tryM(() => {
       const sz = this.Q.shift()
       if (Option.isSome(sz)) {
         return QIO.resolve(sz.value)
@@ -60,7 +60,7 @@ export class Queue<A = never> {
    * Inserts an item into the queue
    */
   public offer(a: A): QIO<void> {
-    return QIO.flattenM(
+    return QIO.tryM(
       (): QIO<void> => {
         if (this.T.length === 0) {
           this.Q.add(a)

diff --git a/packages/example/__tests__/Program.test.ts b/packages/example/__tests__/Program.test.ts
@@ -6,7 +6,7 @@ import {canContinue, program} from '../guess-the-number/src/Program'
 
 describe('Program', () => {
   const input = <T>(...arr: T[]): QIO<T> =>
-    QIO.flattenM(
+    QIO.tryM(
       (): QIO<T> => {
         const elm = arr.shift()