From 460393439a8dd7d94fe02a2013e96c9146282bf1 Mon Sep 17 00:00:00 2001 From: eric thul Date: Wed, 24 Feb 2016 22:53:40 -0500 Subject: Adds dependencies of modules process by the loader. The module file path and dependency graph information is provided by the purescript-webpack-plugin. Resolves #37 --- docs/PursLoader/Options.md | 1 + docs/PursLoader/Plugin.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) create mode 100644 docs/PursLoader/Plugin.md (limited to 'docs') 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 @@ ``` purescript newtype Options + = Options { bundleOutput :: String } ``` ##### 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 @@ +## Module PursLoader.Plugin + +#### `Result` + +``` purescript +type Result = { srcMap :: ImmutableMap String String, ffiMap :: ImmutableMap String String, graph :: DependencyGraph } +``` + +#### `Compile` + +``` purescript +type Compile eff = Nullable Error -> Result -> Eff eff Unit +``` + +#### `Context` + +``` purescript +type Context eff = { compile :: Compile eff -> Eff eff Unit } +``` + +#### `get` + +``` purescript +get :: forall key value. ImmutableMap key value -> key -> Maybe value +``` + +#### `dependenciesOf` + +``` purescript +dependenciesOf :: DependencyGraph -> String -> Either Error (Array String) +``` + +#### `ImmutableMap` + +``` purescript +data ImmutableMap :: * -> * -> * +``` + +#### `DependencyGraph` + +``` purescript +data DependencyGraph :: * +``` + + -- cgit v1.2.3