Node.FS.Async

type Callback a = Either Error a -> Effect Unit

Type synonym for callback functions.

access :: FilePath -> (Maybe Error -> Effect Unit) -> Effect Unit

access' :: FilePath -> AccessMode -> (Maybe Error -> Effect Unit) -> Effect Unit

copyFile :: FilePath -> FilePath -> Callback Unit -> Effect Unit

copyFile' :: FilePath -> FilePath -> CopyMode -> Callback Unit -> Effect Unit

mkdtemp :: String -> Callback String -> Effect Unit

mkdtemp' :: String -> Encoding -> Callback String -> Effect Unit

rename :: FilePath -> FilePath -> Callback Unit -> Effect Unit

Renames a file.

truncate :: FilePath -> Int -> Callback Unit -> Effect Unit

Truncates a file to the specified length.

chown :: FilePath -> Int -> Int -> Callback Unit -> Effect Unit

Changes the ownership of a file.

chmod :: FilePath -> Perms -> Callback Unit -> Effect Unit

Changes the permissions of a file.

lstat :: FilePath -> Callback Stats -> Effect Unit

Gets file or symlink statistics. lstat is identical to stat, except that if the FilePath is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

stat :: FilePath -> Callback Stats -> Effect Unit

Gets file statistics.

link :: FilePath -> FilePath -> Callback Unit -> Effect Unit

Creates a link to an existing file.

symlink :: FilePath -> FilePath -> SymlinkType -> Callback Unit -> Effect Unit

Creates a symlink.

readlink :: FilePath -> Callback FilePath -> Effect Unit

Reads the value of a symlink.

realpath :: FilePath -> Callback FilePath -> Effect Unit

Find the canonicalized absolute location for a path.

realpath' :: forall cache. FilePath -> Record cache -> Callback FilePath -> Effect Unit

Find the canonicalized absolute location for a path using a cache object for already resolved paths.

unlink :: FilePath -> Callback Unit -> Effect Unit

Deletes a file.

rmdir :: FilePath -> Callback Unit -> Effect Unit

Deletes a directory.

rmdir' :: FilePath -> { maxRetries :: Int, retryDelay :: Int } -> Callback Unit -> Effect Unit

Deletes a directory with options.

rm :: FilePath -> Callback Unit -> Effect Unit

Deletes a file or directory.

rm' :: FilePath -> { force :: Boolean, maxRetries :: Int, recursive :: Boolean, retryDelay :: Int } -> Callback Unit -> Effect Unit

Deletes a file or directory with options.

mkdir :: FilePath -> Callback Unit -> Effect Unit

Makes a new directory.

mkdir' :: FilePath -> { mode :: Perms, recursive :: Boolean } -> Callback Unit -> Effect Unit

Makes a new directory with the specified permissions.

readdir :: FilePath -> Callback (Array FilePath) -> Effect Unit

Reads the contents of a directory.

utimes :: FilePath -> DateTime -> DateTime -> Callback Unit -> Effect Unit

Sets the accessed and modified times for the specified file.

readFile :: FilePath -> Callback Buffer -> Effect Unit

Reads the entire contents of a file returning the result as a raw buffer.

readTextFile :: Encoding -> FilePath -> Callback String -> Effect Unit

Reads the entire contents of a text file with the specified encoding.

writeFile :: FilePath -> Buffer -> Callback Unit -> Effect Unit

Writes a buffer to a file.

writeTextFile :: Encoding -> FilePath -> String -> Callback Unit -> Effect Unit

Writes text to a file using the specified encoding.

appendFile :: FilePath -> Buffer -> Callback Unit -> Effect Unit

Appends the contents of a buffer to a file.

appendTextFile :: Encoding -> FilePath -> String -> Callback Unit -> Effect Unit

Appends text to a file using the specified encoding.

fdOpen :: FilePath -> FileFlags -> Maybe FileMode -> Callback FileDescriptor -> Effect Unit

Open a file asynchronously. See the Node Documentation for details.

fdRead :: FileDescriptor -> Buffer -> BufferOffset -> BufferLength -> Maybe FilePosition -> Callback ByteCount -> Effect Unit

Read from a file asynchronously. See the Node Documentation for details.

fdNext :: FileDescriptor -> Buffer -> Callback ByteCount -> Effect Unit

Convenience function to fill the whole buffer from the current file position.

fdWrite :: FileDescriptor -> Buffer -> BufferOffset -> BufferLength -> Maybe FilePosition -> Callback ByteCount -> Effect Unit

Write to a file asynchronously. See the Node Documentation for details.

fdAppend :: FileDescriptor -> Buffer -> Callback ByteCount -> Effect Unit

Convenience function to append the whole buffer to the current file position.

fdClose :: FileDescriptor -> Callback Unit -> Effect Unit

Close a file asynchronously. See the Node Documentation for details.