new TimeoutStream()
- Source:
Methods
cancel()
Cancels the timeout. Note this has the same effect as calling TimeoutStream#handler with a null
argument.
- Source:
endHandler(endHandler) → {TimeoutStream}
Parameters:
| Name | Type | Description |
|---|---|---|
endHandler |
function |
- Source:
Returns:
- Type
- TimeoutStream
exceptionHandler(handler) → {TimeoutStream}
Parameters:
| Name | Type | Description |
|---|---|---|
handler |
function |
- Source:
Returns:
- Type
- TimeoutStream
fetch(amount) → {TimeoutStream}
Parameters:
| Name | Type | Description |
|---|---|---|
amount |
number |
- Source:
Returns:
- Type
- TimeoutStream
handler(handler) → {TimeoutStream}
Parameters:
| Name | Type | Description |
|---|---|---|
handler |
function |
- Source:
Returns:
- Type
- TimeoutStream
pause() → {TimeoutStream}
- Source:
Returns:
- Type
- TimeoutStream
pipe() → {Pipe}
Pause this stream and return a to transfer the elements of this stream to a destination .
The stream will be resumed when the pipe will be wired to a
WriteStream.
- Source:
Returns:
a pipe
- Type
- Pipe
pipeTo(dst, handler)
Pipe this
ReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
Parameters:
| Name | Type | Description |
|---|---|---|
dst |
WriteStream | the destination write stream |
handler |
function |
- Source:
resume() → {TimeoutStream}
- Source:
Returns:
- Type
- TimeoutStream