From 03b840cb5fb8ff5217fefc9e1240a3131db309fc Mon Sep 17 00:00:00 2001 From: eric thul Date: Tue, 11 Aug 2015 20:57:07 -0400 Subject: PureScript 0.7 updates and migration to pulp --- docs/PursLoader/ChildProcess.md | 15 ++++++++++++ docs/PursLoader/FS.md | 21 +++++++++++++++++ docs/PursLoader/Glob.md | 15 ++++++++++++ docs/PursLoader/Loader.md | 21 +++++++++++++++++ docs/PursLoader/LoaderRef.md | 51 +++++++++++++++++++++++++++++++++++++++++ docs/PursLoader/LoaderUtil.md | 9 ++++++++ docs/PursLoader/Options.md | 21 +++++++++++++++++ 7 files changed, 153 insertions(+) create mode 100644 docs/PursLoader/ChildProcess.md create mode 100644 docs/PursLoader/FS.md create mode 100644 docs/PursLoader/Glob.md create mode 100644 docs/PursLoader/Loader.md create mode 100644 docs/PursLoader/LoaderRef.md create mode 100644 docs/PursLoader/LoaderUtil.md create mode 100644 docs/PursLoader/Options.md (limited to 'docs/PursLoader') 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 @@ +## Module PursLoader.ChildProcess + +#### `ChildProcess` + +``` purescript +data ChildProcess :: ! +``` + +#### `spawn` + +``` purescript +spawn :: forall eff. String -> Array String -> Aff (cp :: ChildProcess | eff) String +``` + + 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 @@ +## Module PursLoader.FS + +#### `FS` + +``` purescript +data FS :: ! +``` + +#### `writeFileUtf8` + +``` purescript +writeFileUtf8 :: forall eff. String -> String -> Aff (fs :: FS | eff) Unit +``` + +#### `findFileUtf8` + +``` purescript +findFileUtf8 :: forall eff. Regex -> Array String -> Aff (fs :: FS | eff) (Maybe String) +``` + + 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 @@ +## Module PursLoader.Glob + +#### `Glob` + +``` purescript +data Glob :: ! +``` + +#### `globAll` + +``` purescript +globAll :: forall eff. Array String -> Aff (glob :: Glob | eff) (Array (Array String)) +``` + + 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 @@ +## Module PursLoader.Loader + +#### `Effects` + +``` purescript +type Effects eff = (cp :: ChildProcess, fs :: FS, glob :: Glob, loader :: Loader | eff) +``` + +#### `loader` + +``` purescript +loader :: forall eff. LoaderRef -> String -> Eff (Effects eff) Unit +``` + +#### `loaderFn` + +``` purescript +loaderFn :: forall eff. Fn2 LoaderRef String (Eff (Effects eff) Unit) +``` + + 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 @@ +## Module PursLoader.LoaderRef + +#### `LoaderRef` + +``` purescript +data LoaderRef +``` + +#### `Loader` + +``` purescript +data Loader :: ! +``` + +#### `async` + +``` purescript +async :: forall eff a. LoaderRef -> Eff (loader :: Loader | eff) (Maybe Error -> a -> Eff (loader :: Loader | eff) Unit) +``` + +#### `cacheable` + +``` purescript +cacheable :: forall eff. LoaderRef -> Eff (loader :: Loader | eff) Unit +``` + +#### `query` + +``` purescript +query :: LoaderRef -> String +``` + +#### `clearDependencies` + +``` purescript +clearDependencies :: forall eff. LoaderRef -> Eff (loader :: Loader | eff) Unit +``` + +#### `resourcePath` + +``` purescript +resourcePath :: LoaderRef -> String +``` + +#### `addDependency` + +``` purescript +addDependency :: forall eff. LoaderRef -> String -> Eff (loader :: Loader | eff) Unit +``` + + 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 @@ +## Module PursLoader.LoaderUtil + +#### `parseQuery` + +``` purescript +parseQuery :: String -> Foreign +``` + + 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 @@ +## Module PursLoader.Options + +#### `pscOptions` + +``` purescript +pscOptions :: Foreign -> Array String +``` + +#### `loaderSrcOption` + +``` purescript +loaderSrcOption :: Foreign -> Maybe (Array String) +``` + +#### `loaderFFIOption` + +``` purescript +loaderFFIOption :: Foreign -> Maybe (Array String) +``` + + -- cgit v1.2.3