Module

Node.Stream.Readable

Package
purescript-node-readable
Repository
matthewleon/purescript-node-readable

#Readable Source

newtype Readable chunktype r

A readable stream parameterized by the type of its chunks

Instances

#ReadCb Source

type ReadCb chunktype r = Readable chunktype r -> Size -> Effect Unit

The read callback for readable streams

#Size Source

type Size = Int

#newReadable Source

newReadable :: forall chunktype r. Chunkable chunktype => ReadCb chunktype r -> Effect (Readable chunktype r)

#newReadable' Source

newReadable' :: forall optionsrow rest chunktype r. Union optionsrow rest StreamOptions => Chunkable chunktype => Record optionsrow -> ReadCb chunktype r -> Effect (Readable chunktype r)

#repeat Source

repeat :: forall chunktype r. Chunkable chunktype => chunktype -> Effect (Readable chunktype r)

#repeat' Source

repeat' :: forall optionsrow rest chunktype r. Union optionsrow rest StreamOptions => Chunkable chunktype => Record optionsrow -> chunktype -> Effect (Readable chunktype r)

#iterate Source

iterate :: forall chunktype iterstate r. Chunkable chunktype => (iterstate -> Tuple iterstate chunktype) -> iterstate -> Effect (Readable chunktype r)

#iterate' Source

iterate' :: forall optionsrow rest chunktype iterstate r. Union optionsrow rest StreamOptions => Chunkable chunktype => Record optionsrow -> (iterstate -> Tuple iterstate chunktype) -> iterstate -> Effect (Readable chunktype r)

#unfoldr Source

unfoldr :: forall chunktype iterstate r. Chunkable chunktype => (iterstate -> Maybe (Tuple chunktype iterstate)) -> iterstate -> Effect (Readable chunktype r)

#unfoldr' Source

unfoldr' :: forall optionsrow rest chunktype iterstate r. Union optionsrow rest StreamOptions => Chunkable chunktype => Record optionsrow -> (iterstate -> Maybe (Tuple chunktype iterstate)) -> iterstate -> Effect (Readable chunktype r)

#push Source

push :: forall chunktype r. Readable chunktype r -> chunktype -> Effect Boolean

#pushStringWithEncoding Source

#pushEnd Source

pushEnd :: forall chunktype r. Readable chunktype r -> Effect Unit

#pipe Source

pipe :: forall chunktype w r. Readable chunktype w -> Writable r -> Effect (Writable r)