Merge pull request #19 from slamdata/refinements

Refinements

Author: jdegoes

README.md

@@ -19,7 +19,7 @@
     "package.json"
   ],
   "dependencies": {
-    "purescript-aff": "~0.10.0",
+    "purescript-aff": "~0.10.1",
     "purescript-arraybuffer-types": "~0.1.1",
     "purescript-dom": "~0.1.2",
     "purescript-foreign": "~0.4.2",

bower.json

@@ -0,0 +1,130 @@
+# Module Documentation
+
+## Module Network.HTTP.Affjax.Request
+
+#### `RequestContent`
+
+``` purescript
+data RequestContent :: *
+```
+
+Type representing all content types that be sent via XHR (ArrayBufferView,
+Blob, Document, String, FormData).
+
+#### `Requestable`
+
+``` purescript
+class Requestable a where
+  toRequest :: a -> RequestContent
+```
+
+A class for types that can be converted to values that can be sent with
+XHR requests.
+
+#### `requestableRequestContent`
+
+``` purescript
+instance requestableRequestContent :: Requestable RequestContent
+```
+
+
+#### `requestableInt8Array`
+
+``` purescript
+instance requestableInt8Array :: Requestable (A.ArrayView A.Int8)
+```
+
+
+#### `requestableInt16Array`
+
+``` purescript
+instance requestableInt16Array :: Requestable (A.ArrayView A.Int16)
+```
+
+
+#### `requestableInt32Array`
+
+``` purescript
+instance requestableInt32Array :: Requestable (A.ArrayView A.Int32)
+```
+
+
+#### `requestableUint8Array`
+
+``` purescript
+instance requestableUint8Array :: Requestable (A.ArrayView A.Uint8)
+```
+
+
+#### `requestableUint16Array`
+
+``` purescript
+instance requestableUint16Array :: Requestable (A.ArrayView A.Uint16)
+```
+
+
+#### `requestableUint32Array`
+
+``` purescript
+instance requestableUint32Array :: Requestable (A.ArrayView A.Uint32)
+```
+
+
+#### `requestableUint8ClampedArray`
+
+``` purescript
+instance requestableUint8ClampedArray :: Requestable (A.ArrayView A.Uint8Clamped)
+```
+
+
+#### `requestableFloat32Array`
+
+``` purescript
+instance requestableFloat32Array :: Requestable (A.ArrayView A.Float32)
+```
+
+
+#### `requestableFloat64Array`
+
+``` purescript
+instance requestableFloat64Array :: Requestable (A.ArrayView A.Float64)
+```
+
+
+#### `requestableBlob`
+
+``` purescript
+instance requestableBlob :: Requestable Blob
+```
+
+
+#### `requestableDocument`
+
+``` purescript
+instance requestableDocument :: Requestable Document
+```
+
+
+#### `requestableString`
+
+``` purescript
+instance requestableString :: Requestable String
+```
+
+
+#### `requestableFormData`
+
+``` purescript
+instance requestableFormData :: Requestable FormData
+```
+
+
+#### `requestableUnit`
+
+``` purescript
+instance requestableUnit :: Requestable Unit
+```
+
+
+
+

docs/Network.HTTP.Affjax.Request.md

@@ -0,0 +1,89 @@
+# Module Documentation
+
+## Module Network.HTTP.Affjax.Response
+
+#### `ResponseType`
+
+``` purescript
+data ResponseType
+```
+
+Valid response types for an AJAX request. This is used to determine the
+`ResponseContent` type for a request.
+
+#### `eqResponseType`
+
+``` purescript
+instance eqResponseType :: Eq ResponseType
+```
+
+
+#### `showResponseType`
+
+``` purescript
+instance showResponseType :: Show ResponseType
+```
+
+
+#### `responseTypeToString`
+
+``` purescript
+responseTypeToString :: ResponseType -> String
+```
+
+
+#### `ResponseContent`
+
+``` purescript
+type ResponseContent = Foreign
+```
+
+Type representing content types that be received from an XHR request
+(Blob, Document, JSON, String).
+
+#### `Respondable`
+
+``` purescript
+class Respondable a where
+  responseType :: Proxy a -> ResponseType
+  fromResponse :: ResponseContent -> F a
+```
+
+
+#### `responsableBlob`
+
+``` purescript
+instance responsableBlob :: Respondable Blob
+```
+
+
+#### `responsableDocument`
+
+``` purescript
+instance responsableDocument :: Respondable Document
+```
+
+
+#### `responsableJSON`
+
+``` purescript
+instance responsableJSON :: Respondable Foreign
+```
+
+
+#### `responsableString`
+
+``` purescript
+instance responsableString :: Respondable String
+```
+
+
+#### `responsableUnit`
+
+``` purescript
+instance responsableUnit :: Respondable Unit
+```
+
+
+
+

docs/Network.HTTP.Affjax.Response.md

@@ -0,0 +1,160 @@
+# Module Documentation
+
+## Module Network.HTTP.Affjax
+
+#### `AJAX`
+
+``` purescript
+data AJAX :: !
+```
+
+The effect type for AJAX requests made with Affjax.
+
+#### `Affjax`
+
+``` purescript
+type Affjax e a = Aff (ajax :: AJAX | e) (AffjaxResponse a)
+```
+
+The type for Affjax requests.
+
+#### `AffjaxRequest`
+
+``` purescript
+type AffjaxRequest a = { password :: Maybe String, username :: Maybe String, content :: Maybe a, headers :: [RequestHeader], url :: URL, method :: Method }
+```
+
+
+#### `defaultRequest`
+
+``` purescript
+defaultRequest :: AffjaxRequest Unit
+```
+
+
+#### `AffjaxResponse`
+
+``` purescript
+type AffjaxResponse a = { response :: a, headers :: [ResponseHeader], status :: StatusCode }
+```
+
+The type of records that will be received as an Affjax response.
+
+#### `URL`
+
+``` purescript
+type URL = String
+```
+
+Type alias for URL strings to aid readability of types.
+
+#### `affjax`
+
+``` purescript
+affjax :: forall e a b. (Requestable a, Respondable b) => AffjaxRequest a -> Affjax e b
+```
+
+Makes an `Affjax` request.
+
+#### `get`
+
+``` purescript
+get :: forall e a. (Respondable a) => URL -> Affjax e a
+```
+
+Makes a `GET` request to the specified URL.
+
+#### `post`
+
+``` purescript
+post :: forall e a b. (Requestable a, Respondable b) => URL -> a -> Affjax e b
+```
+
+Makes a `POST` request to the specified URL, sending data.
+
+#### `post'`
+
+``` purescript
+post' :: forall e a b. (Requestable a, Respondable b) => URL -> Maybe a -> Affjax e b
+```
+
+Makes a `POST` request to the specified URL with the option to send data.
+
+#### `post_`
+
+``` purescript
+post_ :: forall e a. (Requestable a) => URL -> a -> Affjax e Unit
+```
+
+Makes a `POST` request to the specified URL, sending data and ignoring the
+response.
+
+#### `post_'`
+
+``` purescript
+post_' :: forall e a. (Requestable a) => URL -> Maybe a -> Affjax e Unit
+```
+
+Makes a `POST` request to the specified URL with the option to send data,
+and ignores the response.
+
+#### `put`
+
+``` purescript
+put :: forall e a b. (Requestable a, Respondable b) => URL -> a -> Affjax e b
+```
+
+Makes a `PUT` request to the specified URL, sending data.
+
+#### `put'`
+
+``` purescript
+put' :: forall e a b. (Requestable a, Respondable b) => URL -> Maybe a -> Affjax e b
+```
+
+Makes a `PUT` request to the specified URL with the option to send data.
+
+#### `put_`
+
+``` purescript
+put_ :: forall e a. (Requestable a) => URL -> a -> Affjax e Unit
+```
+
+Makes a `PUT` request to the specified URL, sending data and ignoring the
+response.
+
+#### `put_'`
+
+``` purescript
+put_' :: forall e a. (Requestable a) => URL -> Maybe a -> Affjax e Unit
+```
+
+Makes a `PUT` request to the specified URL with the option to send data,
+and ignores the response.
+
+#### `delete`
+
+``` purescript
+delete :: forall e a. (Respondable a) => URL -> Affjax e a
+```
+
+Makes a `DELETE` request to the specified URL.
+
+#### `delete_`
+
+``` purescript
+delete_ :: forall e. URL -> Affjax e Unit
+```
+
+Makes a `DELETE` request to the specified URL and ignores the response.
+
+#### `affjax'`
+
+``` purescript
+affjax' :: forall e a b. (Requestable a, Respondable b) => AffjaxRequest a -> (Error -> Eff (ajax :: AJAX | e) Unit) -> (AffjaxResponse b -> Eff (ajax :: AJAX | e) Unit) -> Eff (ajax :: AJAX | e) (Canceler (ajax :: AJAX | e))
+```
+
+Run a request directly without using `Aff`.
+
+
+