diff options
author | eric <thul.eric@gmail.com> | 2016-02-25 21:48:42 -0500 |
---|---|---|
committer | eric <thul.eric@gmail.com> | 2016-02-25 21:48:42 -0500 |
commit | d7d4ec32989320d0fb62413d59b137279824de5b (patch) | |
tree | 2ab19c4a3f01925f1ee5c29f99c4f6cd6e5c1166 /docs/PursLoader/Plugin.md | |
parent | ef1525b5a0fe3f4561493aaca49907dba827dbd6 (diff) | |
parent | f97818b550b17455448ff7fe09689b326c30912b (diff) | |
download | purs-loader-d7d4ec32989320d0fb62413d59b137279824de5b.tar.gz purs-loader-d7d4ec32989320d0fb62413d59b137279824de5b.tar.zst purs-loader-d7d4ec32989320d0fb62413d59b137279824de5b.zip |
Merge pull request #38 from ethul/topic/dependency-graph
Topic/dependency graph
Diffstat (limited to 'docs/PursLoader/Plugin.md')
-rw-r--r-- | docs/PursLoader/Plugin.md | 45 |
1 files changed, 45 insertions, 0 deletions
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 | ||
6 | type Result = { srcMap :: ImmutableMap String String, ffiMap :: ImmutableMap String String, graph :: DependencyGraph } | ||
7 | ``` | ||
8 | |||
9 | #### `Compile` | ||
10 | |||
11 | ``` purescript | ||
12 | type Compile eff = Nullable Error -> Result -> Eff eff Unit | ||
13 | ``` | ||
14 | |||
15 | #### `Context` | ||
16 | |||
17 | ``` purescript | ||
18 | type Context eff = { compile :: Compile eff -> Eff eff Unit } | ||
19 | ``` | ||
20 | |||
21 | #### `get` | ||
22 | |||
23 | ``` purescript | ||
24 | get :: forall key value. ImmutableMap key value -> key -> Maybe value | ||
25 | ``` | ||
26 | |||
27 | #### `dependenciesOf` | ||
28 | |||
29 | ``` purescript | ||
30 | dependenciesOf :: DependencyGraph -> String -> Either Error (Array String) | ||
31 | ``` | ||
32 | |||
33 | #### `ImmutableMap` | ||
34 | |||
35 | ``` purescript | ||
36 | data ImmutableMap :: * -> * -> * | ||
37 | ``` | ||
38 | |||
39 | #### `DependencyGraph` | ||
40 | |||
41 | ``` purescript | ||
42 | data DependencyGraph :: * | ||
43 | ``` | ||
44 | |||
45 | |||