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