Payload.Client.Queryable

type ClientFnWithOptions payload body = RequestOptions -> ClientFn payload body

type ClientFn payload body = payload -> Aff (ClientResponse body)

class Queryable route (basePath :: Symbol) (baseParams :: Row Type) payload res | route baseParams basePath -> payload, route -> res where

Members

• request :: route -> Proxy basePath -> Proxy (Record baseParams) -> Options -> ClientFnWithOptions payload res

Instances

• (Lacks "body" route, Union route DefaultRouteSpec mergedRoute, Nub mergedRoute routeWithDefaults, TypeEquals (Record routeWithDefaults) { params :: Record params, query :: query, response :: res | r }, Union baseParams params fullUrlParams, Append basePath path fullPath, RowToList fullUrlParams fullParamsList, EncodeUrlWithParams fullPath fullParamsList payload, EncodeOptionalQuery fullPath query payload, DecodeResponse res) => Queryable (Route "GET" path (Record route)) basePath baseParams (Record payload) res
• (Union route DefaultRouteSpec mergedRoute, Nub mergedRoute routeWithDefaults, TypeEquals (Record routeWithDefaults) { body :: body, params :: Record params, query :: query, response :: res | r }, Union baseParams params fullUrlParams, Append basePath path fullPath, RowToList fullUrlParams fullParamsList, EncodeUrlWithParams fullPath fullParamsList payload, EncodeOptionalQuery fullPath query payload, EncodeOptionalBody body payload, HasContentType body, DecodeResponse res) => Queryable (Route "POST" path (Record route)) basePath baseParams (Record payload) res
• (Lacks "body" route, Lacks "response" route, Union route DefaultRouteSpec mergedRoute, Nub mergedRoute routeWithDefaults, TypeEquals (Record routeWithDefaults) { params :: Record params, query :: query | r }, Append basePath path fullPath, Union baseParams params fullUrlParams, RowToList fullUrlParams fullParamsList, EncodeUrlWithParams fullPath fullParamsList payload, EncodeOptionalQuery fullPath query payload) => Queryable (Route "HEAD" path (Record route)) basePath baseParams (Record payload) String
• (Union route DefaultRouteSpec mergedRoute, Nub mergedRoute routeWithDefaults, TypeEquals (Record routeWithDefaults) { body :: body, params :: Record params, query :: query, response :: res | r }, Union baseParams params fullUrlParams, Append basePath path fullPath, RowToList fullUrlParams fullParamsList, EncodeUrlWithParams fullPath fullParamsList payload, EncodeOptionalQuery fullPath query payload, EncodeOptionalBody body payload, HasContentType body, DecodeResponse res) => Queryable (Route "PUT" path (Record route)) basePath baseParams (Record payload) res
• (Union route DefaultRouteSpec mergedRoute, Nub mergedRoute routeWithDefaults, TypeEquals (Record routeWithDefaults) { body :: body, params :: Record params, query :: query, response :: res | r }, Union baseParams params fullUrlParams, Append basePath path fullPath, DecodeResponse res, RowToList fullUrlParams fullParamsList, EncodeUrlWithParams fullPath fullParamsList payload, EncodeOptionalQuery fullPath query payload, EncodeOptionalBody body payload, HasContentType body) => Queryable (Route "DELETE" path (Record route)) basePath baseParams (Record payload) res
• (Lacks "body" route, Union route DefaultRouteSpec mergedRoute, Nub mergedRoute routeWithDefaults, TypeEquals (Record routeWithDefaults) { params :: Record params, query :: query, response :: res | r }, Union baseParams params fullUrlParams, Append basePath path fullPath, RowToList fullUrlParams fullParamsList, EncodeUrlWithParams fullPath fullParamsList payload, EncodeOptionalQuery fullPath query payload, DecodeResponse res) => Queryable (Route "OPTIONS" path (Record route)) basePath baseParams (Record payload) res

type Request = { body :: Maybe RequestBody, headers :: Array RequestHeader, method :: Method, opts :: Options, reqOpts :: RequestOptions, url :: String }

makeRequest :: forall body. DecodeResponse body => Request -> Aff (ClientResponse body)

printRequest :: Request String -> String

printResponse :: Either Error (Response String) -> String

lookupHeader :: String -> Array ResponseHeader -> Maybe String

decodeAffjaxResponse :: forall body. DecodeResponse body => Either Error (Response String) -> ClientResponse body

decodeError :: Response String -> DecodeResponseError -> ClientError

bodyResponse :: forall a. Response String -> a -> Response a

asPayloadResponse :: Response String -> Response String

statusAndHeaders :: forall a. Response a -> { headers :: Headers, status :: HttpStatus }

asHeaderTuple :: ResponseHeader -> Tuple String String

class EncodeOptionalBody (body :: Type) (payload :: Row Type)  where

Members

• encodeOptionalBody :: Proxy body -> Record payload -> Maybe RequestBody

Instances

• EncodeOptionalBody Undefined payload
• (TypeEquals (Record payload) { body :: body | rest }, EncodeBody body) => EncodeOptionalBody body payload

class EncodeOptionalQuery (url :: Symbol) (query :: Type) (payload :: Row Type)  where

Members

• encodeOptionalQuery :: Proxy url -> Proxy query -> Record payload -> String

Instances

• (EncodeQuery url ()) => EncodeOptionalQuery url Undefined payload
• (TypeEquals (Record payload) { query :: Record query | rest }, EncodeQuery url query) => EncodeOptionalQuery url (Record query) payload

class EncodeUrlWithParams (url :: Symbol) (params :: RowList Type) (payload :: Row Type)  where

Members

• encodeUrlWithParams :: Options -> Proxy url -> Proxy params -> Record payload -> String

Instances

• (EncodeUrl url ()) => EncodeUrlWithParams url Nil payload
• (TypeEquals (Record payload) { params :: Record params | rest }, ListToRow rl params, EncodeUrl url params) => EncodeUrlWithParams url rl payload

encodeUrl :: forall url params. EncodeUrl url params => Options -> Proxy url -> Record params -> String

stripTrailingSlash :: String -> String

appendHeaders :: forall a. Headers -> Request a -> Request a