|
| 1 | +# Module Documentation |
| 2 | + |
| 3 | +## Module GulpPurescript.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 GulpPurescript.FS |
| 21 | + |
| 22 | +#### `FS` |
| 23 | + |
| 24 | +``` purescript |
| 25 | +data FS :: ! |
| 26 | +``` |
| 27 | + |
| 28 | + |
| 29 | +#### `Stream` |
| 30 | + |
| 31 | +``` purescript |
| 32 | +data Stream i o |
| 33 | +``` |
| 34 | + |
| 35 | + |
| 36 | +#### `createWriteStream` |
| 37 | + |
| 38 | +``` purescript |
| 39 | +createWriteStream :: forall eff. String -> Eff (fs :: FS | eff) (Stream String Unit) |
| 40 | +``` |
| 41 | + |
| 42 | + |
| 43 | + |
| 44 | +## Module GulpPurescript.GulpUtil |
| 45 | + |
| 46 | +#### `File` |
| 47 | + |
| 48 | +``` purescript |
| 49 | +data File |
| 50 | +``` |
| 51 | + |
| 52 | + |
| 53 | +#### `mkPluginError` |
| 54 | + |
| 55 | +``` purescript |
| 56 | +mkPluginError :: String -> String -> Error |
| 57 | +``` |
| 58 | + |
| 59 | + |
| 60 | +#### `mkFile` |
| 61 | + |
| 62 | +``` purescript |
| 63 | +mkFile :: String -> String -> File |
| 64 | +``` |
| 65 | + |
| 66 | + |
| 67 | +#### `filePath` |
| 68 | + |
| 69 | +``` purescript |
| 70 | +filePath :: File -> String |
| 71 | +``` |
| 72 | + |
| 73 | + |
| 74 | +#### `fileIsNull` |
| 75 | + |
| 76 | +``` purescript |
| 77 | +fileIsNull :: File -> Boolean |
| 78 | +``` |
| 79 | + |
| 80 | + |
| 81 | +#### `fileIsStream` |
| 82 | + |
| 83 | +``` purescript |
| 84 | +fileIsStream :: File -> Boolean |
| 85 | +``` |
| 86 | + |
| 87 | + |
| 88 | + |
| 89 | +## Module GulpPurescript.Logalot |
| 90 | + |
| 91 | +#### `Logalot` |
| 92 | + |
| 93 | +``` purescript |
| 94 | +data Logalot :: ! |
| 95 | +``` |
| 96 | + |
| 97 | + |
| 98 | +#### `info` |
| 99 | + |
| 100 | +``` purescript |
| 101 | +info :: forall eff. String -> Eff (logalot :: Logalot | eff) Unit |
| 102 | +``` |
| 103 | + |
| 104 | + |
| 105 | + |
| 106 | +## Module GulpPurescript.Minimist |
| 107 | + |
| 108 | +#### `minimist` |
| 109 | + |
| 110 | +``` purescript |
| 111 | +minimist :: forall a. (IsForeign a) => [String] -> Maybe a |
| 112 | +``` |
| 113 | + |
| 114 | + |
| 115 | + |
| 116 | +## Module GulpPurescript.Multipipe |
| 117 | + |
| 118 | +#### `multipipe2` |
| 119 | + |
| 120 | +``` purescript |
| 121 | +multipipe2 :: forall a b c. Stream a b -> Stream b c -> Stream a c |
| 122 | +``` |
| 123 | + |
| 124 | + |
| 125 | + |
| 126 | +## Module GulpPurescript.OS |
| 127 | + |
| 128 | +#### `OS` |
| 129 | + |
| 130 | +``` purescript |
| 131 | +data OS :: ! |
| 132 | +``` |
| 133 | + |
| 134 | + |
| 135 | +#### `Platform` |
| 136 | + |
| 137 | +``` purescript |
| 138 | +data Platform |
| 139 | + = Darwin |
| 140 | + | Linux |
| 141 | + | Win32 |
| 142 | +``` |
| 143 | + |
| 144 | + |
| 145 | +#### `showPlatform` |
| 146 | + |
| 147 | +``` purescript |
| 148 | +instance showPlatform :: Show Platform |
| 149 | +``` |
| 150 | + |
| 151 | + |
| 152 | +#### `isForeignPlatform` |
| 153 | + |
| 154 | +``` purescript |
| 155 | +instance isForeignPlatform :: IsForeign Platform |
| 156 | +``` |
| 157 | + |
| 158 | + |
| 159 | +#### `platform` |
| 160 | + |
| 161 | +``` purescript |
| 162 | +platform :: forall eff. Eff (os :: OS | eff) (Maybe Platform) |
| 163 | +``` |
| 164 | + |
| 165 | + |
| 166 | + |
| 167 | +## Module GulpPurescript.Options |
| 168 | + |
| 169 | +#### `isForeignPsc` |
| 170 | + |
| 171 | +``` purescript |
| 172 | +instance isForeignPsc :: IsForeign Psc |
| 173 | +``` |
| 174 | + |
| 175 | + |
| 176 | +#### `isForeignPscMake` |
| 177 | + |
| 178 | +``` purescript |
| 179 | +instance isForeignPscMake :: IsForeign PscMake |
| 180 | +``` |
| 181 | + |
| 182 | + |
| 183 | +#### `isForeignPscDocs` |
| 184 | + |
| 185 | +``` purescript |
| 186 | +instance isForeignPscDocs :: IsForeign PscDocs |
| 187 | +``` |
| 188 | + |
| 189 | + |
| 190 | +#### `isForeignFormat` |
| 191 | + |
| 192 | +``` purescript |
| 193 | +instance isForeignFormat :: IsForeign Format |
| 194 | +``` |
| 195 | + |
| 196 | + |
| 197 | +#### `pscOptions` |
| 198 | + |
| 199 | +``` purescript |
| 200 | +pscOptions :: Foreign -> [String] |
| 201 | +``` |
| 202 | + |
| 203 | + |
| 204 | +#### `pscMakeOptions` |
| 205 | + |
| 206 | +``` purescript |
| 207 | +pscMakeOptions :: Foreign -> [String] |
| 208 | +``` |
| 209 | + |
| 210 | + |
| 211 | +#### `pscDocsOptions` |
| 212 | + |
| 213 | +``` purescript |
| 214 | +pscDocsOptions :: Foreign -> [String] |
| 215 | +``` |
| 216 | + |
| 217 | + |
| 218 | + |
| 219 | +## Module GulpPurescript.Package |
| 220 | + |
| 221 | +#### `Pkg` |
| 222 | + |
| 223 | +``` purescript |
| 224 | +data Pkg :: ! |
| 225 | +``` |
| 226 | + |
| 227 | + |
| 228 | +#### `Package` |
| 229 | + |
| 230 | +``` purescript |
| 231 | +newtype Package |
| 232 | + = Package { name :: String } |
| 233 | +``` |
| 234 | + |
| 235 | + |
| 236 | +#### `isForeignPackage` |
| 237 | + |
| 238 | +``` purescript |
| 239 | +instance isForeignPackage :: IsForeign Package |
| 240 | +``` |
| 241 | + |
| 242 | + |
| 243 | +#### `package` |
| 244 | + |
| 245 | +``` purescript |
| 246 | +package :: forall eff. Eff (package :: Pkg | eff) (Maybe Package) |
| 247 | +``` |
| 248 | + |
| 249 | + |
| 250 | + |
| 251 | +## Module GulpPurescript.Path |
| 252 | + |
| 253 | +#### `relative` |
| 254 | + |
| 255 | +``` purescript |
| 256 | +relative :: String -> String -> String |
| 257 | +``` |
| 258 | + |
| 259 | + |
| 260 | + |
| 261 | +## Module GulpPurescript.Plugin |
| 262 | + |
| 263 | +#### `isForeignArgv` |
| 264 | + |
| 265 | +``` purescript |
| 266 | +instance isForeignArgv :: IsForeign Argv |
| 267 | +``` |
| 268 | + |
| 269 | + |
| 270 | +#### `Effects` |
| 271 | + |
| 272 | +``` purescript |
| 273 | +type Effects eff = (which :: Which, through2 :: Through2, resolveBin :: ResolveBin, package :: Pkg, os :: OS, logalot :: Logalot, fs :: FS, cp :: ChildProcess | eff) |
| 274 | +``` |
| 275 | + |
| 276 | + |
| 277 | +#### `psc` |
| 278 | + |
| 279 | +``` purescript |
| 280 | +psc :: forall eff. Foreign -> Eff (Effects eff) (Stream File File) |
| 281 | +``` |
| 282 | + |
| 283 | + |
| 284 | +#### `pscMake` |
| 285 | + |
| 286 | +``` purescript |
| 287 | +pscMake :: forall eff. Foreign -> Eff (Effects eff) (Stream File Unit) |
| 288 | +``` |
| 289 | + |
| 290 | + |
| 291 | +#### `pscDocs` |
| 292 | + |
| 293 | +``` purescript |
| 294 | +pscDocs :: forall eff. Foreign -> Eff (Effects eff) (Stream File File) |
| 295 | +``` |
| 296 | + |
| 297 | + |
| 298 | +#### `dotPsci` |
| 299 | + |
| 300 | +``` purescript |
| 301 | +dotPsci :: forall eff. Eff (Effects eff) (Stream File Unit) |
| 302 | +``` |
| 303 | + |
| 304 | + |
| 305 | + |
| 306 | +## Module GulpPurescript.ResolveBin |
| 307 | + |
| 308 | +#### `ResolveBin` |
| 309 | + |
| 310 | +``` purescript |
| 311 | +data ResolveBin :: ! |
| 312 | +``` |
| 313 | + |
| 314 | + |
| 315 | +#### `Options` |
| 316 | + |
| 317 | +``` purescript |
| 318 | +type Options = { executable :: String } |
| 319 | +``` |
| 320 | + |
| 321 | + |
| 322 | +#### `resolveBin` |
| 323 | + |
| 324 | +``` purescript |
| 325 | +resolveBin :: forall eff. String -> Options -> Aff (resolveBin :: ResolveBin | eff) String |
| 326 | +``` |
| 327 | + |
| 328 | + |
| 329 | + |
| 330 | +## Module GulpPurescript.Through2 |
| 331 | + |
| 332 | +#### `Through2` |
| 333 | + |
| 334 | +``` purescript |
| 335 | +data Through2 :: ! |
| 336 | +``` |
| 337 | + |
| 338 | + |
| 339 | +#### `RunAff` |
| 340 | + |
| 341 | +``` purescript |
| 342 | +type RunAff eff a = (Error -> Eff eff Unit) -> (a -> Eff eff Unit) -> Aff eff a -> Eff eff Unit |
| 343 | +``` |
| 344 | + |
| 345 | + |
| 346 | +#### `objStream` |
| 347 | + |
| 348 | +``` purescript |
| 349 | +objStream :: forall eff1 eff2 input output. (input -> Aff eff1 output) -> Eff (through2 :: Through2 | eff2) (Stream input output) |
| 350 | +``` |
| 351 | + |
| 352 | + |
| 353 | +#### `accStream` |
| 354 | + |
| 355 | +``` purescript |
| 356 | +accStream :: forall eff1 eff2 input output. (input -> Aff eff1 output) -> Eff (through2 :: Through2 | eff2) (Stream input [output]) |
| 357 | +``` |
| 358 | + |
| 359 | + |
| 360 | + |
| 361 | +## Module GulpPurescript.Which |
| 362 | + |
| 363 | +#### `Which` |
| 364 | + |
| 365 | +``` purescript |
| 366 | +data Which :: ! |
| 367 | +``` |
| 368 | + |
| 369 | + |
| 370 | +#### `which` |
| 371 | + |
| 372 | +``` purescript |
| 373 | +which :: forall eff. String -> Aff (which :: Which | eff) String |
| 374 | +``` |
| 375 | + |
| 376 | + |
| 377 | + |
| 378 | + |
0 commit comments