aboutsummaryrefslogtreecommitdiffhomepage
path: root/MODULE.md
diff options
context:
space:
mode:
authoreric thul <thul.eric@gmail.com>2015-07-06 23:57:59 -0400
committereric thul <thul.eric@gmail.com>2015-07-06 23:57:59 -0400
commit167c852f657b4746331c4f89e358a4a4876ced78 (patch)
treea063817b17ee2df146228cf66c4205c2d80f05be /MODULE.md
parent0e1221d7b15e578d5e9146b01e11a24007d4ba9b (diff)
downloadpurs-loader-167c852f657b4746331c4f89e358a4a4876ced78.tar.gz
purs-loader-167c852f657b4746331c4f89e358a4a4876ced78.tar.zst
purs-loader-167c852f657b4746331c4f89e358a4a4876ced78.zip
Updating module documentation
Diffstat (limited to 'MODULE.md')
-rw-r--r--MODULE.md97
1 files changed, 14 insertions, 83 deletions
diff --git a/MODULE.md b/MODULE.md
index 2d54719..45f6cca 100644
--- a/MODULE.md
+++ b/MODULE.md
@@ -26,17 +26,10 @@ data FS :: !
26``` 26```
27 27
28 28
29#### `readFileUtf8` 29#### `writeFileUtf8`
30 30
31``` purescript 31``` purescript
32readFileUtf8 :: forall eff. String -> Aff (fs :: FS | eff) String 32writeFileUtf8 :: forall eff. String -> String -> Aff (fs :: FS | eff) Unit
33```
34
35
36#### `readFileUtf8Sync`
37
38``` purescript
39readFileUtf8Sync :: forall eff. String -> Eff (fs :: FS | eff) String
40``` 33```
41 34
42 35
@@ -50,34 +43,34 @@ data Glob :: !
50``` 43```
51 44
52 45
53#### `glob` 46#### `globAll`
54 47
55``` purescript 48``` purescript
56glob :: forall eff. String -> Aff (glob :: Glob | eff) [String] 49globAll :: forall eff. [String] -> Aff (glob :: Glob | eff) [[String]]
57``` 50```
58 51
59 52
60 53
61## Module PursLoader.Loader 54## Module PursLoader.Loader
62 55
63#### `LoaderEff` 56#### `Effects`
64 57
65``` purescript 58``` purescript
66type LoaderEff eff a = Eff (fs :: FS, cp :: ChildProcess, glob :: Glob, loader :: Loader | eff) a 59type Effects eff = (loader :: Loader, glob :: Glob, fs :: FS, cp :: ChildProcess | eff)
67``` 60```
68 61
69 62
70#### `loader` 63#### `loader`
71 64
72``` purescript 65``` purescript
73loader :: forall eff. LoaderRef -> String -> LoaderEff eff Unit 66loader :: forall eff. LoaderRef -> String -> Eff (Effects eff) Unit
74``` 67```
75 68
76 69
77#### `loaderFn` 70#### `loaderFn`
78 71
79``` purescript 72``` purescript
80loaderFn :: forall eff. Fn2 LoaderRef String (LoaderEff eff Unit) 73loaderFn :: forall eff. Fn2 LoaderRef String (Eff (Effects eff) Unit)
81``` 74```
82 75
83 76
@@ -112,27 +105,6 @@ cacheable :: forall eff. LoaderRef -> Eff (loader :: Loader | eff) Unit
112``` 105```
113 106
114 107
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` 108#### `query`
137 109
138``` purescript 110``` purescript
@@ -143,13 +115,6 @@ query :: LoaderRef -> String
143 115
144## Module PursLoader.LoaderUtil 116## Module PursLoader.LoaderUtil
145 117
146#### `getRemainingRequest`
147
148``` purescript
149getRemainingRequest :: LoaderRef -> String
150```
151
152
153#### `parseQuery` 118#### `parseQuery`
154 119
155``` purescript 120``` purescript
@@ -158,16 +123,6 @@ parseQuery :: String -> Foreign
158 123
159 124
160 125
161## Module PursLoader.OS
162
163#### `eol`
164
165``` purescript
166eol :: String
167```
168
169
170
171## Module PursLoader.Options 126## Module PursLoader.Options
172 127
173#### `isForeignOptions` 128#### `isForeignOptions`
@@ -191,17 +146,17 @@ instance stringLoaderOption :: LoaderOption String
191``` 146```
192 147
193 148
194#### `pscMakeOutputOption` 149#### `arrayLoaderOption`
195 150
196``` purescript 151``` purescript
197pscMakeOutputOption :: Foreign -> Maybe String 152instance arrayLoaderOption :: (LoaderOption a) => LoaderOption [a]
198``` 153```
199 154
200 155
201#### `pscMakeOptions` 156#### `pscOptions`
202 157
203``` purescript 158``` purescript
204pscMakeOptions :: Foreign -> [String] 159pscOptions :: Foreign -> [String]
205``` 160```
206 161
207 162
@@ -212,34 +167,10 @@ loaderSrcOption :: Foreign -> Maybe [String]
212``` 167```
213 168
214 169
215 170#### `loaderFFIOption`
216## Module PursLoader.Path
217
218#### `dirname`
219
220``` purescript
221dirname :: String -> String
222```
223
224
225#### `join`
226
227``` purescript
228join :: [String] -> String
229```
230
231
232#### `relative`
233
234``` purescript
235relative :: String -> String -> String
236```
237
238
239#### `resolve`
240 171
241``` purescript 172``` purescript
242resolve :: String -> String 173loaderFFIOption :: Foreign -> Maybe [String]
243``` 174```
244 175
245 176