Merge pull request #9 from felixSchl/feature-async-before-after

Add async versions of before and after hooks

Author: Isaac Shapira

README.md

@@ -6,50 +6,193 @@
 
 ## Module Test.Mocha
 
-### Types
+#### `Before`
 
-    data After :: !
+``` purescript
+data Before :: !
+```
 
-    data Before :: !
 
-    data Describe :: !
+#### `Describe`
 
-    type DoDescribe  = forall e a. String -> Eff e a -> Eff (describe :: Describe | e) Unit
+``` purescript
+data Describe :: !
+```
 
-    type DoIt  = forall e a. String -> Eff e a -> Eff (it :: It | e) Unit
 
-    data Done :: !
+#### `It`
 
-    data DoneToken where
-      DoneToken :: DoneToken
+``` purescript
+data It :: !
+```
 
-    data It :: !
 
+#### `After`
 
-### Values
+``` purescript
+data After :: !
+```
 
-    after :: forall e a. Eff e a -> Eff (after :: After | e) Unit
 
-    afterEach :: forall e a. Eff e a -> Eff (after :: After | e) Unit
+#### `Done`
 
-    before :: forall e a. Eff e a -> Eff (before :: Before | e) Unit
+``` purescript
+data Done :: !
+```
 
-    beforeEach :: forall e a. Eff e a -> Eff (before :: Before | e) Unit
 
-    describe :: DoDescribe
+#### `DoIt`
 
-    describeOnly :: DoDescribe
+``` purescript
+type DoIt = forall e a. String -> Eff e a -> Eff (it :: It | e) Unit
+```
 
-    describeSkip :: DoDescribe
 
-    it :: DoIt
+#### `DoDescribe`
 
-    itAsync :: forall a eff. String -> (DoneToken -> Eff (done :: Done | eff) a) -> Eff (it :: It | eff) Unit
+``` purescript
+type DoDescribe = forall e a. String -> Eff (describe :: Describe | e) a -> Eff (describe :: Describe | e) Unit
+```
 
-    itIs :: forall eff. DoneToken -> Eff (done :: Done | eff) Unit
 
-    itIsNot :: forall eff. DoneToken -> Eff (done :: Done | eff) Unit
+#### `DoBefore`
 
-    itOnly :: DoIt
+``` purescript
+type DoBefore = forall e a. Eff e a -> Eff (before :: Before | e) Unit
+```
 
-    itSkip :: DoIt
+
+#### `DoAfter`
+
+``` purescript
+type DoAfter = forall e a. Eff e a -> Eff (after :: After | e) Unit
+```
+
+
+#### `DoneToken`
+
+``` purescript
+data DoneToken
+  = DoneToken 
+```
+
+
+#### `describe`
+
+``` purescript
+describe :: DoDescribe
+```
+
+
+#### `describeOnly`
+
+``` purescript
+describeOnly :: DoDescribe
+```
+
+
+#### `describeSkip`
+
+``` purescript
+describeSkip :: DoDescribe
+```
+
+
+#### `it`
+
+``` purescript
+it :: DoIt
+```
+
+
+#### `itOnly`
+
+``` purescript
+itOnly :: DoIt
+```
+
+
+#### `itSkip`
+
+``` purescript
+itSkip :: DoIt
+```
+
+
+#### `itAsync`
+
+``` purescript
+itAsync :: forall a eff. String -> (DoneToken -> Eff (done :: Done | eff) a) -> Eff (it :: It | eff) Unit
+```
+
+
+#### `itIs`
+
+``` purescript
+itIs :: forall eff. DoneToken -> Eff (done :: Done | eff) Unit
+```
+
+
+#### `itIsNot`
+
+``` purescript
+itIsNot :: forall eff a. DoneToken -> Eff (done :: Done | eff) Unit
+```
+
+
+#### `before`
+
+``` purescript
+before :: DoBefore
+```
+
+Before Hooks
+
+#### `beforeEach`
+
+``` purescript
+beforeEach :: DoBefore
+```
+
+
+#### `beforeAsync`
+
+``` purescript
+beforeAsync :: forall a eff. (DoneToken -> Eff (done :: Done | eff) a) -> Eff (it :: It | eff) Unit
+```
+
+
+#### `beforeEachAsync`
+
+``` purescript
+beforeEachAsync :: forall a eff. (DoneToken -> Eff (done :: Done | eff) a) -> Eff (it :: It | eff) Unit
+```
+
+
+#### `after`
+
+``` purescript
+after :: DoAfter
+```
+
+After Hooks
+
+#### `afterEach`
+
+``` purescript
+afterEach :: DoAfter
+```
+
+
+#### `afterAsync`
+
+``` purescript
+afterAsync :: forall a eff. (DoneToken -> Eff (done :: Done | eff) a) -> Eff (it :: It | eff) Unit
+```
+
+
+#### `afterEachAsync`
+
+``` purescript
+afterEachAsync :: forall a eff. (DoneToken -> Eff (done :: Done | eff) a) -> Eff (it :: It | eff) Unit
+```