aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authoreric thul <thul.eric@gmail.com>2015-08-11 20:57:07 -0400
committereric thul <thul.eric@gmail.com>2015-08-11 20:57:07 -0400
commit03b840cb5fb8ff5217fefc9e1240a3131db309fc (patch)
tree6183f4453aa15ad67ee0249fb8d35702cef5ecad /docs
parentfa01c5a4cb42d80ac147dc5ab512a0795dbe14da (diff)
downloadpurs-loader-03b840cb5fb8ff5217fefc9e1240a3131db309fc.tar.gz
purs-loader-03b840cb5fb8ff5217fefc9e1240a3131db309fc.tar.zst
purs-loader-03b840cb5fb8ff5217fefc9e1240a3131db309fc.zip
PureScript 0.7 updates and migration to pulp
Diffstat (limited to 'docs')
-rw-r--r--docs/PursLoader/ChildProcess.md15
-rw-r--r--docs/PursLoader/FS.md21
-rw-r--r--docs/PursLoader/Glob.md15
-rw-r--r--docs/PursLoader/Loader.md21
-rw-r--r--docs/PursLoader/LoaderRef.md51
-rw-r--r--docs/PursLoader/LoaderUtil.md9
-rw-r--r--docs/PursLoader/Options.md21
7 files changed, 153 insertions, 0 deletions
diff --git a/docs/PursLoader/ChildProcess.md b/docs/PursLoader/ChildProcess.md
new file mode 100644
index 0000000..7c2e414
--- /dev/null
+++ b/docs/PursLoader/ChildProcess.md
@@ -0,0 +1,15 @@
1## Module PursLoader.ChildProcess
2
3#### `ChildProcess`
4
5``` purescript
6data ChildProcess :: !
7```
8
9#### `spawn`
10
11``` purescript
12spawn :: forall eff. String -> Array String -> Aff (cp :: ChildProcess | eff) String
13```
14
15
diff --git a/docs/PursLoader/FS.md b/docs/PursLoader/FS.md
new file mode 100644
index 0000000..811fcbd
--- /dev/null
+++ b/docs/PursLoader/FS.md
@@ -0,0 +1,21 @@
1## Module PursLoader.FS
2
3#### `FS`
4
5``` purescript
6data FS :: !
7```
8
9#### `writeFileUtf8`
10
11``` purescript
12writeFileUtf8 :: forall eff. String -> String -> Aff (fs :: FS | eff) Unit
13```
14
15#### `findFileUtf8`
16
17``` purescript
18findFileUtf8 :: forall eff. Regex -> Array String -> Aff (fs :: FS | eff) (Maybe String)
19```
20
21
diff --git a/docs/PursLoader/Glob.md b/docs/PursLoader/Glob.md
new file mode 100644
index 0000000..f7abe78
--- /dev/null
+++ b/docs/PursLoader/Glob.md
@@ -0,0 +1,15 @@
1## Module PursLoader.Glob
2
3#### `Glob`
4
5``` purescript
6data Glob :: !
7```
8
9#### `globAll`
10
11``` purescript
12globAll :: forall eff. Array String -> Aff (glob :: Glob | eff) (Array (Array String))
13```
14
15
diff --git a/docs/PursLoader/Loader.md b/docs/PursLoader/Loader.md
new file mode 100644
index 0000000..8e91c4a
--- /dev/null
+++ b/docs/PursLoader/Loader.md
@@ -0,0 +1,21 @@
1## Module PursLoader.Loader
2
3#### `Effects`
4
5``` purescript
6type Effects eff = (cp :: ChildProcess, fs :: FS, glob :: Glob, loader :: Loader | eff)
7```
8
9#### `loader`
10
11``` purescript
12loader :: forall eff. LoaderRef -> String -> Eff (Effects eff) Unit
13```
14
15#### `loaderFn`
16
17``` purescript
18loaderFn :: forall eff. Fn2 LoaderRef String (Eff (Effects eff) Unit)
19```
20
21
diff --git a/docs/PursLoader/LoaderRef.md b/docs/PursLoader/LoaderRef.md
new file mode 100644
index 0000000..36c1550
--- /dev/null
+++ b/docs/PursLoader/LoaderRef.md
@@ -0,0 +1,51 @@
1## Module PursLoader.LoaderRef
2
3#### `LoaderRef`
4
5``` purescript
6data LoaderRef
7```
8
9#### `Loader`
10
11``` purescript
12data Loader :: !
13```
14
15#### `async`
16
17``` purescript
18async :: forall eff a. LoaderRef -> Eff (loader :: Loader | eff) (Maybe Error -> a -> Eff (loader :: Loader | eff) Unit)
19```
20
21#### `cacheable`
22
23``` purescript
24cacheable :: forall eff. LoaderRef -> Eff (loader :: Loader | eff) Unit
25```
26
27#### `query`
28
29``` purescript
30query :: LoaderRef -> String
31```
32
33#### `clearDependencies`
34
35``` purescript
36clearDependencies :: forall eff. LoaderRef -> Eff (loader :: Loader | eff) Unit
37```
38
39#### `resourcePath`
40
41``` purescript
42resourcePath :: LoaderRef -> String
43```
44
45#### `addDependency`
46
47``` purescript
48addDependency :: forall eff. LoaderRef -> String -> Eff (loader :: Loader | eff) Unit
49```
50
51
diff --git a/docs/PursLoader/LoaderUtil.md b/docs/PursLoader/LoaderUtil.md
new file mode 100644
index 0000000..36d6879
--- /dev/null
+++ b/docs/PursLoader/LoaderUtil.md
@@ -0,0 +1,9 @@
1## Module PursLoader.LoaderUtil
2
3#### `parseQuery`
4
5``` purescript
6parseQuery :: String -> Foreign
7```
8
9
diff --git a/docs/PursLoader/Options.md b/docs/PursLoader/Options.md
new file mode 100644
index 0000000..d04b721
--- /dev/null
+++ b/docs/PursLoader/Options.md
@@ -0,0 +1,21 @@
1## Module PursLoader.Options
2
3#### `pscOptions`
4
5``` purescript
6pscOptions :: Foreign -> Array String
7```
8
9#### `loaderSrcOption`
10
11``` purescript
12loaderSrcOption :: Foreign -> Maybe (Array String)
13```
14
15#### `loaderFFIOption`
16
17``` purescript
18loaderFFIOption :: Foreign -> Maybe (Array String)
19```
20
21