diff options
author | eric <thul.eric@gmail.com> | 2016-03-12 14:46:01 -0500 |
---|---|---|
committer | eric <thul.eric@gmail.com> | 2016-03-12 14:46:01 -0500 |
commit | 55120f4502cb76e768f60654f3937db809df8ade (patch) | |
tree | f27800de3576466ea4d5502d9adb9cd57a583715 /docs/PursLoader/Plugin.md | |
parent | 17f22f868b851e50081844562627a7a8a414dcaa (diff) | |
parent | 845f3ec3c5b13a47d60b9ff2be14bf41fb5c4734 (diff) | |
download | purs-loader-55120f4502cb76e768f60654f3937db809df8ade.tar.gz purs-loader-55120f4502cb76e768f60654f3937db809df8ade.tar.zst purs-loader-55120f4502cb76e768f60654f3937db809df8ade.zip |
Merge pull request #43 from ethul/topic/optional-bundle
Handle optional bundling by the compiler
Diffstat (limited to 'docs/PursLoader/Plugin.md')
-rw-r--r-- | docs/PursLoader/Plugin.md | 20 |
1 files changed, 4 insertions, 16 deletions
diff --git a/docs/PursLoader/Plugin.md b/docs/PursLoader/Plugin.md index 9abec4d..7a524da 100644 --- a/docs/PursLoader/Plugin.md +++ b/docs/PursLoader/Plugin.md | |||
@@ -1,27 +1,21 @@ | |||
1 | ## Module PursLoader.Plugin | 1 | ## Module PursLoader.Plugin |
2 | 2 | ||
3 | #### `Result` | ||
4 | |||
5 | ``` purescript | ||
6 | type Result = { srcMap :: ImmutableMap String String, ffiMap :: ImmutableMap String String, graph :: DependencyGraph } | ||
7 | ``` | ||
8 | |||
9 | #### `Compile` | 3 | #### `Compile` |
10 | 4 | ||
11 | ``` purescript | 5 | ``` purescript |
12 | type Compile eff = Nullable Error -> Result -> Eff eff Unit | 6 | type Compile eff = Nullable Error -> DependencyGraph -> Eff eff Unit |
13 | ``` | 7 | ``` |
14 | 8 | ||
15 | #### `Context` | 9 | #### `Context` |
16 | 10 | ||
17 | ``` purescript | 11 | ``` purescript |
18 | type Context eff = { compile :: Compile eff -> Eff eff Unit } | 12 | type Context eff = { compile :: Compile eff -> Eff eff Unit, options :: Options } |
19 | ``` | 13 | ``` |
20 | 14 | ||
21 | #### `get` | 15 | #### `Options` |
22 | 16 | ||
23 | ``` purescript | 17 | ``` purescript |
24 | get :: forall key value. ImmutableMap key value -> key -> Maybe value | 18 | type Options = { bundle :: Boolean, output :: String, bundleOutput :: String } |
25 | ``` | 19 | ``` |
26 | 20 | ||
27 | #### `dependenciesOf` | 21 | #### `dependenciesOf` |
@@ -30,12 +24,6 @@ get :: forall key value. ImmutableMap key value -> key -> Maybe value | |||
30 | dependenciesOf :: DependencyGraph -> String -> Either Error (Array String) | 24 | dependenciesOf :: DependencyGraph -> String -> Either Error (Array String) |
31 | ``` | 25 | ``` |
32 | 26 | ||
33 | #### `ImmutableMap` | ||
34 | |||
35 | ``` purescript | ||
36 | data ImmutableMap :: * -> * -> * | ||
37 | ``` | ||
38 | |||
39 | #### `DependencyGraph` | 27 | #### `DependencyGraph` |
40 | 28 | ||
41 | ``` purescript | 29 | ``` purescript |