apiary-0.17.2: Simple and type safe web framework that can be automatically generate API documentation.

Safe HaskellNone
LanguageHaskell2010

Data.Apiary.Param

Synopsis

Documentation

jsToBool :: (IsString a, Eq a) => a -> Bool Source

readPathAs :: Path a => proxy a -> Text -> Maybe a Source

data Text Source

Instances

type Param = (ByteString, ByteString) Source

data File Source

Constructors

File 

Fields

fileParameter :: ByteString
 
fileName :: ByteString
 
fileContentType :: ByteString
 
fileContent :: ByteString
 

Instances

data QueryRep Source

Constructors

Strict TypeRep 
Nullable TypeRep 
Check 
NoValue 

Instances

class Path a where Source

Methods

readPath :: Text -> Maybe a Source

pathRep :: proxy a -> TypeRep Source

Instances

Path Bool

javascript boolean. when "false", "0", "-0", "", "null", "undefined", "NaN" then False, else True. since 0.6.0.0.

Path Char 
Path Double 
Path Float 
Path Int 
Path Int8 
Path Int16 
Path Int32 
Path Int64 
Path Integer 
Path Word 
Path Word8 
Path Word16 
Path Word32 
Path Word64 
Path String 
Path ByteString 
Path ByteString 
Path Text 
Path Text 
Path Day

fuzzy date parse. three decimal split by 1 char. if year < 100 then + 2000. since 0.16.0.

example:

  • 2014-02-05
  • 14-2-5
  • 14.2.05

readText :: Reader a -> Text -> Maybe a Source

readTextInt :: Integral i => Text -> Maybe i Source

readTextWord :: Integral i => Text -> Maybe i Source

readTextDouble :: Text -> Maybe Double Source

class Query a where Source

Minimal complete definition

readQuery, qTypeRep

Methods

readQuery :: Maybe ByteString -> Maybe a Source

queryRep :: proxy a -> QueryRep Source

qTypeRep :: proxy a -> TypeRep Source

Instances

Query Bool

javascript boolean. when "false", "0", "-0", "", "null", "undefined", "NaN" then False, else True. since 0.6.0.0.

Query Double 
Query Float 
Query Int 
Query Int8 
Query Int16 
Query Int32 
Query Int64 
Query Integer 
Query Word 
Query Word8 
Query Word16 
Query Word32 
Query Word64 
Query String 
Query ()

always success. for check existence.

Query ByteString 
Query ByteString 
Query Text 
Query Text 
Query Day

fuzzy date parse. three decimal split by 1 char. if year < 100 then + 2000. since 0.16.0.

example:

  • 2014-02-05
  • 14-2-5
  • 14.2.05
Query a => Query (Maybe a)

allow no parameter. but check parameter type.

readBS :: (ByteString -> Maybe (a, ByteString)) -> ByteString -> Maybe a Source

readBSInt :: Integral a => ByteString -> Maybe a Source

readBSWord :: Integral a => ByteString -> Maybe a Source

readBSDouble :: ByteString -> Maybe Double Source

pBool :: Proxy Bool Source

pInt :: Proxy Int Source

pInt8 :: Proxy Int8 Source

pInt16 :: Proxy Int16 Source

pInt32 :: Proxy Int32 Source

pInt64 :: Proxy Int64 Source

pInteger :: Proxy Integer Source

pWord :: Proxy Word Source

pWord8 :: Proxy Word8 Source

pWord16 :: Proxy Word16 Source

pWord32 :: Proxy Word32 Source

pWord64 :: Proxy Word64 Source

pDouble :: Proxy Double Source

pFloat :: Proxy Float Source

pText :: Proxy Text Source

pLazyText :: Proxy Text Source

pByteString :: Proxy ByteString Source

pLazyByteString :: Proxy ByteString Source

pString :: Proxy String Source

pVoid :: Proxy () Source

pMaybe :: proxy a -> Proxy (Maybe a) Source

pFile :: Proxy File Source

class ReqParam a where Source

Methods

reqParams :: proxy a -> Request -> [Param] -> [File] -> [(ByteString, Maybe a)] Source

reqParamRep :: proxy a -> QueryRep Source

Instances