envelope 0.2.0.1 → 0.2.1.0

raw patch · 2 files changed

+17/−1 lines, 2 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• envelope.cabal +1/−1
• src/Web/Envelope.hs +16/−0

@@ -1,5 +1,5 @@ name:                envelope-version:             0.2.0.1+version:             0.2.1.0 synopsis:            Defines generic 'Envelope' type to wrap reponses from a JSON API. description:         Please see README.md homepage:            https://github.com/cdepillabout/envelope#readme

@@ -49,6 +49,8 @@     , Envelope'(..)     , Success(..)     , Err(..)+    , toErr+    , toErr'     , throwEnvelopeErr     , throwEnvelopeErr'     , toSuccessEnvelope@@ -207,6 +209,20 @@          FromForm (Err e) where   fromForm :: Form -> Either Text (Err e)   fromForm form = Err <$> parseUnique "error" form <*> lookupMaybe "extra" form++-- | Smart constructor for 'Err'.+--+-- >>> toErr "DB_ERROR" "an error occurred"+-- Err {errErr = "DB_ERROR", errExtra = Just "an error occurred"}+toErr :: e -> Text -> Err e+toErr e extra = Err e (Just extra)++-- | Smart constructor for 'Err' that doesn't use an 'errExtra'.+--+-- >>> toErr' "DB_ERROR"+-- Err {errErr = "DB_ERROR", errExtra = Nothing}+toErr' :: e -> Err e+toErr' e = Err e Nothing  -- | Wrap an @a@ in a success 'Envelope'. --