1- # Module Documentation
2-
31## Module Node.FS.Aff
42
53
6-
74[ Node.FS] [ Node.FS ] Wrappers for [ purescript-aff] [ aff ]
85
96The ` Aff ` monad let's you write async code with ease.
@@ -18,7 +15,7 @@ main = launchAff do
1815 return $
1916 FS.isDirectory stat
2017 && (maybe false (fromChar >>> (/= ".")) $ charAt 0 file)
21- liftEff $ Debug.Trace.trace $ show files'
18+ liftEff $ print files'
2219```
2320
2421That was easy. For a working example, see [ example.purs] [ example ] .
@@ -31,7 +28,7 @@ To build the example, run `gulp example`.
3128#### ` rename `
3229
3330``` purescript
34- rename :: forall eff. FilePath -> FilePath -> Aff (fs :: F. FS | eff) Unit
31+ rename :: forall eff. FilePath -> FilePath -> Aff (fs :: FS | eff) Unit
3532```
3633
3734
@@ -41,7 +38,7 @@ Rename a file.
4138#### ` truncate `
4239
4340``` purescript
44- truncate :: forall eff. FilePath -> Number -> Aff (fs :: F. FS | eff) Unit
41+ truncate :: forall eff. FilePath -> Number -> Aff (fs :: FS | eff) Unit
4542```
4643
4744
@@ -51,7 +48,7 @@ Truncates a file to the specified length.
5148#### ` chown `
5249
5350``` purescript
54- chown :: forall eff. FilePath -> Number -> Number -> Aff (fs :: F. FS | eff) Unit
51+ chown :: forall eff. FilePath -> Number -> Number -> Aff (fs :: FS | eff) Unit
5552```
5653
5754
@@ -61,7 +58,7 @@ Changes the ownership of a file.
6158#### ` chmod `
6259
6360``` purescript
64- chmod :: forall eff. FilePath -> Perms -> Aff (fs :: F. FS | eff) Unit
61+ chmod :: forall eff. FilePath -> Perms -> Aff (fs :: FS | eff) Unit
6562```
6663
6764
@@ -71,7 +68,7 @@ Changes the permissions of a file.
7168#### ` stat `
7269
7370``` purescript
74- stat :: forall eff. FilePath -> Aff (fs :: F. FS | eff) Stats
71+ stat :: forall eff. FilePath -> Aff (fs :: FS | eff) Stats
7572```
7673
7774
@@ -81,7 +78,7 @@ Gets file statistics.
8178#### ` link `
8279
8380``` purescript
84- link :: forall eff. FilePath -> FilePath -> Aff (fs :: F. FS | eff) Unit
81+ link :: forall eff. FilePath -> FilePath -> Aff (fs :: FS | eff) Unit
8582```
8683
8784
@@ -91,7 +88,7 @@ Creates a link to an existing file.
9188#### ` symlink `
9289
9390``` purescript
94- symlink :: forall eff. FilePath -> FilePath -> F. SymlinkType -> Aff (fs :: F. FS | eff) Unit
91+ symlink :: forall eff. FilePath -> FilePath -> SymlinkType -> Aff (fs :: FS | eff) Unit
9592```
9693
9794
@@ -101,7 +98,7 @@ Creates a symlink.
10198#### ` readlink `
10299
103100``` purescript
104- readlink :: forall eff. FilePath -> Aff (fs :: F. FS | eff) FilePath
101+ readlink :: forall eff. FilePath -> Aff (fs :: FS | eff) FilePath
105102```
106103
107104
@@ -111,7 +108,7 @@ Reads the value of a symlink.
111108#### ` realpath `
112109
113110``` purescript
114- realpath :: forall eff. FilePath -> Aff (fs :: F. FS | eff) FilePath
111+ realpath :: forall eff. FilePath -> Aff (fs :: FS | eff) FilePath
115112```
116113
117114
@@ -121,7 +118,7 @@ Find the canonicalized absolute location for a path.
121118#### ` realpath' `
122119
123120``` purescript
124- realpath' :: forall eff cache. FilePath -> { | cache } -> Aff (fs :: F. FS | eff) FilePath
121+ realpath' :: forall eff cache. FilePath -> { | cache } -> Aff (fs :: FS | eff) FilePath
125122```
126123
127124
@@ -132,7 +129,7 @@ for already resolved paths.
132129#### ` unlink `
133130
134131``` purescript
135- unlink :: forall eff. FilePath -> Aff (fs :: F. FS | eff) Unit
132+ unlink :: forall eff. FilePath -> Aff (fs :: FS | eff) Unit
136133```
137134
138135
@@ -142,7 +139,7 @@ Deletes a file.
142139#### ` rmdir `
143140
144141``` purescript
145- rmdir :: forall eff. FilePath -> Aff (fs :: F. FS | eff) Unit
142+ rmdir :: forall eff. FilePath -> Aff (fs :: FS | eff) Unit
146143```
147144
148145
@@ -152,7 +149,7 @@ Deletes a directory.
152149#### ` mkdir `
153150
154151``` purescript
155- mkdir :: forall eff. FilePath -> Aff (fs :: F. FS | eff) Unit
152+ mkdir :: forall eff. FilePath -> Aff (fs :: FS | eff) Unit
156153```
157154
158155
@@ -162,7 +159,7 @@ Makes a new directory.
162159#### ` mkdir' `
163160
164161``` purescript
165- mkdir' :: forall eff. FilePath -> Perms -> Aff (fs :: F. FS | eff) Unit
162+ mkdir' :: forall eff. FilePath -> Perms -> Aff (fs :: FS | eff) Unit
166163```
167164
168165
@@ -172,7 +169,7 @@ Makes a new directory with the specified permissions.
172169#### ` readdir `
173170
174171``` purescript
175- readdir :: forall eff. FilePath -> Aff (fs :: F. FS | eff) [ FilePath]
172+ readdir :: forall eff. FilePath -> Aff (fs :: FS | eff) (Array FilePath)
176173```
177174
178175
@@ -182,7 +179,7 @@ Reads the contents of a directory.
182179#### ` utimes `
183180
184181``` purescript
185- utimes :: forall eff. FilePath -> Date -> Date -> Aff (fs :: F. FS | eff) Unit
182+ utimes :: forall eff. FilePath -> Date -> Date -> Aff (fs :: FS | eff) Unit
186183```
187184
188185
@@ -192,7 +189,7 @@ Sets the accessed and modified times for the specified file.
192189#### ` readFile `
193190
194191``` purescript
195- readFile :: forall eff. FilePath -> Aff (fs :: F. FS | eff) Buffer
192+ readFile :: forall eff. FilePath -> Aff (fs :: FS | eff) Buffer
196193```
197194
198195
@@ -202,7 +199,7 @@ Reads the entire contents of a file returning the result as a raw buffer.
202199#### ` readTextFile `
203200
204201``` purescript
205- readTextFile :: forall eff. Encoding -> FilePath -> Aff (fs :: F. FS | eff) String
202+ readTextFile :: forall eff. Encoding -> FilePath -> Aff (fs :: FS | eff) String
206203```
207204
208205
@@ -212,7 +209,7 @@ Reads the entire contents of a text file with the specified encoding.
212209#### ` writeFile `
213210
214211``` purescript
215- writeFile :: forall eff. FilePath -> Buffer -> Aff (fs :: F. FS | eff) Unit
212+ writeFile :: forall eff. FilePath -> Buffer -> Aff (fs :: FS | eff) Unit
216213```
217214
218215
@@ -222,7 +219,7 @@ Writes a buffer to a file.
222219#### ` writeTextFile `
223220
224221``` purescript
225- writeTextFile :: forall eff. Encoding -> FilePath -> String -> Aff (fs :: F. FS | eff) Unit
222+ writeTextFile :: forall eff. Encoding -> FilePath -> String -> Aff (fs :: FS | eff) Unit
226223```
227224
228225
@@ -232,7 +229,7 @@ Writes text to a file using the specified encoding.
232229#### ` appendFile `
233230
234231``` purescript
235- appendFile :: forall eff. FilePath -> Buffer -> Aff (fs :: F. FS | eff) Unit
232+ appendFile :: forall eff. FilePath -> Buffer -> Aff (fs :: FS | eff) Unit
236233```
237234
238235
@@ -242,7 +239,7 @@ Appends the contents of a buffer to a file.
242239#### ` appendTextFile `
243240
244241``` purescript
245- appendTextFile :: forall eff. Encoding -> FilePath -> String -> Aff (fs :: F. FS | eff) Unit
242+ appendTextFile :: forall eff. Encoding -> FilePath -> String -> Aff (fs :: FS | eff) Unit
246243```
247244
248245
@@ -252,12 +249,11 @@ Appends text to a file using the specified encoding.
252249#### ` exists `
253250
254251``` purescript
255- exists :: forall eff. String -> Aff (fs :: F. FS | eff) Boolean
252+ exists :: forall eff. String -> Aff (fs :: FS | eff) Boolean
256253```
257254
258255
259256Check to see if a file exists.
260257
261258
262259
263-
0 commit comments