]> git.immae.eu Git - github/fretlink/purs-loader.git/blob - MODULE.md
Moving files to match module
[github/fretlink/purs-loader.git] / MODULE.md
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 #### `writeFileUtf8`
30
31 ``` purescript
32 writeFileUtf8 :: forall eff. String -> String -> Aff (fs :: FS | eff) Unit
33 ```
34
35
36
37 ## Module PursLoader.Glob
38
39 #### `Glob`
40
41 ``` purescript
42 data Glob :: !
43 ```
44
45
46 #### `globAll`
47
48 ``` purescript
49 globAll :: forall eff. [String] -> Aff (glob :: Glob | eff) [[String]]
50 ```
51
52
53
54 ## Module PursLoader.Loader
55
56 #### `Effects`
57
58 ``` purescript
59 type Effects eff = (loader :: Loader, glob :: Glob, fs :: FS, cp :: ChildProcess | eff)
60 ```
61
62
63 #### `loader`
64
65 ``` purescript
66 loader :: forall eff. LoaderRef -> String -> Eff (Effects eff) Unit
67 ```
68
69
70 #### `loaderFn`
71
72 ``` purescript
73 loaderFn :: forall eff. Fn2 LoaderRef String (Eff (Effects eff) Unit)
74 ```
75
76
77
78 ## Module PursLoader.LoaderRef
79
80 #### `LoaderRef`
81
82 ``` purescript
83 data LoaderRef
84 ```
85
86
87 #### `Loader`
88
89 ``` purescript
90 data Loader :: !
91 ```
92
93
94 #### `async`
95
96 ``` purescript
97 async :: forall eff a. LoaderRef -> Eff (loader :: Loader | eff) (Maybe Error -> a -> Eff (loader :: Loader | eff) Unit)
98 ```
99
100
101 #### `cacheable`
102
103 ``` purescript
104 cacheable :: forall eff. LoaderRef -> Eff (loader :: Loader | eff) Unit
105 ```
106
107
108 #### `query`
109
110 ``` purescript
111 query :: LoaderRef -> String
112 ```
113
114
115
116 ## Module PursLoader.LoaderUtil
117
118 #### `parseQuery`
119
120 ``` purescript
121 parseQuery :: String -> Foreign
122 ```
123
124
125
126 ## Module PursLoader.Options
127
128 #### `isForeignOptions`
129
130 ``` purescript
131 instance isForeignOptions :: IsForeign Options
132 ```
133
134
135 #### `booleanLoaderOption`
136
137 ``` purescript
138 instance booleanLoaderOption :: LoaderOption Boolean
139 ```
140
141
142 #### `stringLoaderOption`
143
144 ``` purescript
145 instance stringLoaderOption :: LoaderOption String
146 ```
147
148
149 #### `arrayLoaderOption`
150
151 ``` purescript
152 instance arrayLoaderOption :: (LoaderOption a) => LoaderOption [a]
153 ```
154
155
156 #### `pscOptions`
157
158 ``` purescript
159 pscOptions :: Foreign -> [String]
160 ```
161
162
163 #### `loaderSrcOption`
164
165 ``` purescript
166 loaderSrcOption :: Foreign -> Maybe [String]
167 ```
168
169
170 #### `loaderFFIOption`
171
172 ``` purescript
173 loaderFFIOption :: Foreign -> Maybe [String]
174 ```
175
176
177
178