Module

Node.FS.Stream

Package
purescript-node-fs
Repository
purescript-node/purescript-node-fs

#createWriteStream Source

createWriteStream :: forall eff. FilePath -> Eff (fs :: FS | eff) (Writable () (fs :: FS | eff))

Create a Writable stream which writes data to the specified file, using the default options.

#fdCreateWriteStream Source

fdCreateWriteStream :: forall eff. FileDescriptor -> Eff (fs :: FS | eff) (Writable () (fs :: FS | eff))

Create a Writable stream which writes data to the specified file descriptor, using the default options.

#WriteStreamOptions Source

type WriteStreamOptions = { flags :: FileFlags, perms :: Perms }

#createWriteStreamWith Source

createWriteStreamWith :: forall eff. WriteStreamOptions -> FilePath -> Eff (fs :: FS | eff) (Writable () (fs :: FS | eff))

Like createWriteStream, but allows you to pass options.

#fdCreateWriteStreamWith Source

fdCreateWriteStreamWith :: forall eff. WriteStreamOptions -> FileDescriptor -> Eff (fs :: FS | eff) (Writable () (fs :: FS | eff))

Like fdCreateWriteStream, but allows you to pass options.

#createReadStream Source

createReadStream :: forall eff. FilePath -> Eff (fs :: FS | eff) (Readable () (fs :: FS | eff))

Create a Readable stream which reads data to the specified file, using the default options.

#fdCreateReadStream Source

fdCreateReadStream :: forall eff. FileDescriptor -> Eff (fs :: FS | eff) (Readable () (fs :: FS | eff))

Create a Readable stream which reads data to the specified file descriptor, using the default options.

#ReadStreamOptions Source

type ReadStreamOptions = { autoClose :: Boolean, flags :: FileFlags, perms :: Perms }

#createReadStreamWith Source

createReadStreamWith :: forall eff. ReadStreamOptions -> FilePath -> Eff (fs :: FS | eff) (Readable () (fs :: FS | eff))

Create a Readable stream which reads data from the specified file.

#fdCreateReadStreamWith Source

fdCreateReadStreamWith :: forall eff. ReadStreamOptions -> FileDescriptor -> Eff (fs :: FS | eff) (Readable () (fs :: FS | eff))

Create a Readable stream which reads data from the specified file descriptor.