Skip to content

Commit e288a67

Browse files
committed
Fix response doc
1 parent 6d412ee commit e288a67

File tree

3 files changed

+90
-4
lines changed

3 files changed

+90
-4
lines changed

docs/Network.HTTP.Affjax.Response.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Module Documentation
2+
3+
## Module Network.HTTP.Affjax.Response
4+
5+
#### `ResponseType`
6+
7+
``` purescript
8+
data ResponseType
9+
```
10+
11+
Valid response types for an AJAX request. This is used to determine the
12+
`ResponseContent` type for a request.
13+
14+
#### `eqResponseType`
15+
16+
``` purescript
17+
instance eqResponseType :: Eq ResponseType
18+
```
19+
20+
21+
#### `showResponseType`
22+
23+
``` purescript
24+
instance showResponseType :: Show ResponseType
25+
```
26+
27+
28+
#### `responseTypeToString`
29+
30+
``` purescript
31+
responseTypeToString :: ResponseType -> String
32+
```
33+
34+
35+
#### `ResponseContent`
36+
37+
``` purescript
38+
type ResponseContent = Foreign
39+
```
40+
41+
Type representing content types that be received from an XHR request
42+
(Blob, Document, JSON, String).
43+
44+
#### `Respondable`
45+
46+
``` purescript
47+
class Respondable a where
48+
responseType :: Proxy a -> ResponseType
49+
fromResponse :: ResponseContent -> F a
50+
```
51+
52+
53+
#### `responsableBlob`
54+
55+
``` purescript
56+
instance responsableBlob :: Respondable Blob
57+
```
58+
59+
60+
#### `responsableDocument`
61+
62+
``` purescript
63+
instance responsableDocument :: Respondable Document
64+
```
65+
66+
67+
#### `responsableJSON`
68+
69+
``` purescript
70+
instance responsableJSON :: Respondable Foreign
71+
```
72+
73+
74+
#### `responsableString`
75+
76+
``` purescript
77+
instance responsableString :: Respondable String
78+
```
79+
80+
81+
#### `responsableUnit`
82+
83+
``` purescript
84+
instance responsableUnit :: Respondable Unit
85+
```
86+
87+
88+
89+

docs/Network.HTTP.Response.md

-3
This file was deleted.

gulpfile.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ var docTask = function(name) {
3737
docTasks.push(taskName);
3838
};
3939

40-
["Network.HTTP.Affjax", "Network.HTTP.Affjax.Request", "Network.HTTP.Response",
40+
["Network.HTTP.Affjax", "Network.HTTP.Affjax.Request", "Network.HTTP.Affjax.Response",
4141
"Network.HTTP.Method", "Network.HTTP.MimeType", "Network.HTTP.MimeType.Common",
4242
"Network.HTTP.RequestHeader", "Network.HTTP.ResponseHeader",
4343
"Network.HTTP.StatusCode"].forEach(docTask);

0 commit comments

Comments
 (0)