aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/PursLoader/Options.md1
-rw-r--r--docs/PursLoader/Plugin.md45
2 files changed, 46 insertions, 0 deletions
diff --git a/docs/PursLoader/Options.md b/docs/PursLoader/Options.md
index 2bfcddd..b3352fc 100644
--- a/docs/PursLoader/Options.md
+++ b/docs/PursLoader/Options.md
@@ -4,6 +4,7 @@
4 4
5``` purescript 5``` purescript
6newtype Options 6newtype Options
7 = Options { bundleOutput :: String }
7``` 8```
8 9
9##### Instances 10##### Instances
diff --git a/docs/PursLoader/Plugin.md b/docs/PursLoader/Plugin.md
new file mode 100644
index 0000000..9abec4d
--- /dev/null
+++ b/docs/PursLoader/Plugin.md
@@ -0,0 +1,45 @@
1## Module PursLoader.Plugin
2
3#### `Result`
4
5``` purescript
6type Result = { srcMap :: ImmutableMap String String, ffiMap :: ImmutableMap String String, graph :: DependencyGraph }
7```
8
9#### `Compile`
10
11``` purescript
12type Compile eff = Nullable Error -> Result -> Eff eff Unit
13```
14
15#### `Context`
16
17``` purescript
18type Context eff = { compile :: Compile eff -> Eff eff Unit }
19```
20
21#### `get`
22
23``` purescript
24get :: forall key value. ImmutableMap key value -> key -> Maybe value
25```
26
27#### `dependenciesOf`
28
29``` purescript
30dependenciesOf :: DependencyGraph -> String -> Either Error (Array String)
31```
32
33#### `ImmutableMap`
34
35``` purescript
36data ImmutableMap :: * -> * -> *
37```
38
39#### `DependencyGraph`
40
41``` purescript
42data DependencyGraph :: *
43```
44
45