aboutsummaryrefslogtreecommitdiffhomepage
path: root/MODULE.md
diff options
context:
space:
mode:
authoreric <thul.eric@gmail.com>2015-04-12 11:35:25 -0400
committereric <thul.eric@gmail.com>2015-04-12 11:35:25 -0400
commit7d58cf78c770ef95858f90c6e89bd18653657a82 (patch)
treeebae7549b1a1b14e11fd5e2ad4dd66d901af81c8 /MODULE.md
parent18ced1e0f031df444a5d85d72cd6843d826fef38 (diff)
parent94a23e744896b4440794de5d6cffedff1a1a2d56 (diff)
downloadpurs-loader-7d58cf78c770ef95858f90c6e89bd18653657a82.tar.gz
purs-loader-7d58cf78c770ef95858f90c6e89bd18653657a82.tar.zst
purs-loader-7d58cf78c770ef95858f90c6e89bd18653657a82.zip
Merge pull request #8 from ethul/topic/purescript-rewrite
Topic/purescript rewrite
Diffstat (limited to 'MODULE.md')
-rw-r--r--MODULE.md226
1 files changed, 226 insertions, 0 deletions
diff --git a/MODULE.md b/MODULE.md
new file mode 100644
index 0000000..39d9d3a
--- /dev/null
+++ b/MODULE.md
@@ -0,0 +1,226 @@
1# Module Documentation
2
3## Module PursLoader.ChildProcess
4
5#### `ChildProcess`
6
7``` purescript
8data ChildProcess :: !
9```
10
11
12#### `spawn`
13
14``` purescript
15spawn :: forall eff. String -> [String] -> Aff (cp :: ChildProcess | eff) String
16```
17
18
19
20## Module PursLoader.FS
21
22#### `FS`
23
24``` purescript
25data FS :: !
26```
27
28
29#### `readFileUtf8`
30
31``` purescript
32readFileUtf8 :: forall eff. String -> Aff (fs :: FS | eff) String
33```
34
35
36#### `readFileUtf8Sync`
37
38``` purescript
39readFileUtf8Sync :: forall eff. String -> Eff (fs :: FS | eff) String
40```
41
42
43
44## Module PursLoader.Glob
45
46#### `Glob`
47
48``` purescript
49data Glob :: !
50```
51
52
53#### `glob`
54
55``` purescript
56glob :: forall eff. String -> Aff (glob :: Glob | eff) [String]
57```
58
59
60
61## Module PursLoader.Loader
62
63#### `LoaderEff`
64
65``` purescript
66type LoaderEff eff a = Eff (fs :: FS, cp :: ChildProcess, glob :: Glob, loader :: Loader | eff) a
67```
68
69
70#### `loader`
71
72``` purescript
73loader :: forall eff. LoaderRef -> String -> LoaderEff eff Unit
74```
75
76
77#### `loaderFn`
78
79``` purescript
80loaderFn :: forall eff. Fn2 LoaderRef String (LoaderEff eff Unit)
81```
82
83
84
85## Module PursLoader.LoaderRef
86
87#### `LoaderRef`
88
89``` purescript
90data LoaderRef
91```
92
93
94#### `Loader`
95
96``` purescript
97data Loader :: !
98```
99
100
101#### `async`
102
103``` purescript
104async :: forall eff a. LoaderRef -> Eff (loader :: Loader | eff) (Maybe Error -> a -> Eff (loader :: Loader | eff) Unit)
105```
106
107
108#### `cacheable`
109
110``` purescript
111cacheable :: forall eff. LoaderRef -> Eff (loader :: Loader | eff) Unit
112```
113
114
115#### `clearDependencies`
116
117``` purescript
118clearDependencies :: forall eff. LoaderRef -> Eff (loader :: Loader | eff) Unit
119```
120
121
122#### `resourcePath`
123
124``` purescript
125resourcePath :: LoaderRef -> String
126```
127
128
129#### `addDependency`
130
131``` purescript
132addDependency :: forall eff. LoaderRef -> String -> Eff (loader :: Loader | eff) Unit
133```
134
135
136#### `query`
137
138``` purescript
139query :: LoaderRef -> String
140```
141
142
143
144## Module PursLoader.LoaderUtil
145
146#### `getRemainingRequest`
147
148``` purescript
149getRemainingRequest :: LoaderRef -> String
150```
151
152
153#### `parseQuery`
154
155``` purescript
156parseQuery :: String -> Foreign
157```
158
159
160
161## Module PursLoader.OS
162
163#### `eol`
164
165``` purescript
166eol :: String
167```
168
169
170
171## Module PursLoader.Options
172
173#### `isForeignOptions`
174
175``` purescript
176instance isForeignOptions :: IsForeign Options
177```
178
179
180#### `pscMakeOutputOption`
181
182``` purescript
183pscMakeOutputOption :: Foreign -> Maybe String
184```
185
186
187#### `pscMakeOptions`
188
189``` purescript
190pscMakeOptions :: Foreign -> [String]
191```
192
193
194
195## Module PursLoader.Path
196
197#### `dirname`
198
199``` purescript
200dirname :: String -> String
201```
202
203
204#### `join`
205
206``` purescript
207join :: [String] -> String
208```
209
210
211#### `relative`
212
213``` purescript
214relative :: String -> String -> String
215```
216
217
218#### `resolve`
219
220``` purescript
221resolve :: String -> String
222```
223
224
225
226