From 167c852f657b4746331c4f89e358a4a4876ced78 Mon Sep 17 00:00:00 2001 From: eric thul Date: Mon, 6 Jul 2015 23:57:59 -0400 Subject: [PATCH 1/1] Updating module documentation --- MODULE.md | 97 ++++++++----------------------------------------------- 1 file changed, 14 insertions(+), 83 deletions(-) diff --git a/MODULE.md b/MODULE.md index 2d54719..45f6cca 100644 --- a/MODULE.md +++ b/MODULE.md @@ -26,17 +26,10 @@ data FS :: ! ``` -#### `readFileUtf8` +#### `writeFileUtf8` ``` purescript -readFileUtf8 :: forall eff. String -> Aff (fs :: FS | eff) String -``` - - -#### `readFileUtf8Sync` - -``` purescript -readFileUtf8Sync :: forall eff. String -> Eff (fs :: FS | eff) String +writeFileUtf8 :: forall eff. String -> String -> Aff (fs :: FS | eff) Unit ``` @@ -50,34 +43,34 @@ data Glob :: ! ``` -#### `glob` +#### `globAll` ``` purescript -glob :: forall eff. String -> Aff (glob :: Glob | eff) [String] +globAll :: forall eff. [String] -> Aff (glob :: Glob | eff) [[String]] ``` ## Module PursLoader.Loader -#### `LoaderEff` +#### `Effects` ``` purescript -type LoaderEff eff a = Eff (fs :: FS, cp :: ChildProcess, glob :: Glob, loader :: Loader | eff) a +type Effects eff = (loader :: Loader, glob :: Glob, fs :: FS, cp :: ChildProcess | eff) ``` #### `loader` ``` purescript -loader :: forall eff. LoaderRef -> String -> LoaderEff eff Unit +loader :: forall eff. LoaderRef -> String -> Eff (Effects eff) Unit ``` #### `loaderFn` ``` purescript -loaderFn :: forall eff. Fn2 LoaderRef String (LoaderEff eff Unit) +loaderFn :: forall eff. Fn2 LoaderRef String (Eff (Effects eff) Unit) ``` @@ -112,27 +105,6 @@ cacheable :: forall eff. LoaderRef -> Eff (loader :: Loader | eff) Unit ``` -#### `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 -``` - - #### `query` ``` purescript @@ -143,13 +115,6 @@ query :: LoaderRef -> String ## Module PursLoader.LoaderUtil -#### `getRemainingRequest` - -``` purescript -getRemainingRequest :: LoaderRef -> String -``` - - #### `parseQuery` ``` purescript @@ -158,16 +123,6 @@ parseQuery :: String -> Foreign -## Module PursLoader.OS - -#### `eol` - -``` purescript -eol :: String -``` - - - ## Module PursLoader.Options #### `isForeignOptions` @@ -191,17 +146,17 @@ instance stringLoaderOption :: LoaderOption String ``` -#### `pscMakeOutputOption` +#### `arrayLoaderOption` ``` purescript -pscMakeOutputOption :: Foreign -> Maybe String +instance arrayLoaderOption :: (LoaderOption a) => LoaderOption [a] ``` -#### `pscMakeOptions` +#### `pscOptions` ``` purescript -pscMakeOptions :: Foreign -> [String] +pscOptions :: Foreign -> [String] ``` @@ -212,34 +167,10 @@ loaderSrcOption :: Foreign -> Maybe [String] ``` - -## Module PursLoader.Path - -#### `dirname` - -``` purescript -dirname :: String -> String -``` - - -#### `join` - -``` purescript -join :: [String] -> String -``` - - -#### `relative` - -``` purescript -relative :: String -> String -> String -``` - - -#### `resolve` +#### `loaderFFIOption` ``` purescript -resolve :: String -> String +loaderFFIOption :: Foreign -> Maybe [String] ``` -- 2.41.0