Module

Node.Stream.Aff.Internal

Package
purescript-node-streams-aff
Repository
jamesdbrock/purescript-node-streams-aff

Maybe the stuff in here should be moved into the Node.Stream module?

#onceDrain Source

onceDrain :: forall w. Writable w -> Effect Unit -> Effect (Effect Unit)

Listen for one drain event, call the callback, then remove the event listener.

Returns an effect for removing the event listener before the event is raised.

#onceEnd Source

onceEnd :: forall r. Readable r -> Effect Unit -> Effect (Effect Unit)

Listen for one end event, call the callback, then remove the event listener.

Returns an effect for removing the event listener before the event is raised.

#onceError Source

onceError :: forall r. Stream r -> (Error -> Effect Unit) -> Effect (Effect Unit)

Listen for one error event, call the callback, then remove the event listener.

Returns an effect for removing the event listener before the event is raised.

#onceReadable Source

onceReadable :: forall r. Readable r -> Effect Unit -> Effect (Effect Unit)

Listen for one readable event, call the callback, then remove the event listener.

Returns an effect for removing the event listener before the event is raised.

#readable Source

readable :: forall r. Readable r -> Effect Boolean

The readable.readable property of a stream.

Is true if it is safe to call readable.read(), which means the stream has not been destroyed or emitted 'error' or 'end'.

#writeStreamClose Source

writeStreamClose :: forall w. Writable w -> Effect Unit -> Effect Unit

The writeStream.close([callback]) function.

Accepts a callback that will be executed when the writeStream has closed.