tart-stream-adapter
Stability: 1 - Experimental
Tiny Actor Run-Time in JavaScript adapter for Node.js streams.
Contributors
Overview
Tiny Actor Run-Time in JavaScript adapter for Node.js streams.
Usage
To run the below example run:
npm run readme
"use strict"; var fs = ;var path = ;var stream = ;var streams = ;var tart = ; var sponsor = tart; var reader = fs; var readData = ;var readEnd = ; var readCapabilities = streams; var reader2 = fs; var readEnd2 = ; var printer = ; var read; var readable = ; var readCapabilities = streams;read = ; // delete files/writtenTo.txt before writingvar writeFileName = path;if fs fs; var writer = fs; var writeCapabilities = streams;var write = ;var writeEnd = ; var writeFinished = ; ;;;;;;;;;;
Tests
npm test
Documentation
Public API
- streams.adapt(stream, options)
- streams.adaptReadable(stream, options)
- streams.adaptWritable(stream, options)
streams.adapt(stream, options)
stream
: Stream Node.jsStream
.options
: Object (Default: {})close
: Functionfunction () {}
Actor to receive 'close' event.data
: Functionfunction (message) {}
Actor to receive 'data' events.message.chunk
Buffer|String Data from the stream.message.readSeq
Integer Sequence number to read next.
drain
: Functionfunction () {}
Actor to receive 'drain' event.encoding
: String The encoding to use for Readable, Duplex, or Transform stream.end
: Functionfunction () {}
Actor to receive 'end' event.fail
: Functionfunction (error) {}
Actor to receive 'error' events.finish
: Functionfunction () {}
Actor to receive 'finish' event.readable
: Functionfunction (message) {}
Actor to receive 'readable' event notification.message.readSeq
: Integer Sequence number to read next.
- Return: Object Capabilities wrapping the
stream
.
Adapts the stream
to Tart. Returned Capabilities are:
endBeh
: Functionfunction (message) {}
End capability.pauseBeh
: Functionfunction (message) {}
Pause capability.readBeh
: Functionfunction (message) {}
Read capability.resumeBeh
: Functionfunction (message) {}
Resume capability.unshiftBeh
: Functionfunction (message) {}
Unshift capability.writeBeh
: Functionfunction (message) {}
Write capability.
streams.adaptReadable(stream, options)
stream
: Stream Node.jsStream
.options
: Object (Default: {})close
: Functionfunction () {}
Actor to receive 'close' event.data
: Functionfunction (message) {}
Actor to receive 'data' events.message.chunk
Buffer|String Data from the stream.message.readSeq
Integer Sequence number to read next.
encoding
: String The encoding to use for Readable, Duplex, or Transform stream.end
: Functionfunction () {}
Actor to receive 'end' event.fail
: Functionfunction (error) {}
Actor to receive 'error' events.readable
: Functionfunction (message) {}
Actor to receive 'readable' event notification.message.readSeq
: Integer Sequence number to read next.
- Return: Object Capabilities wrapping the readable
stream
.
Adapts a readable stream
. Returned Capabilities are:
pauseBeh
: Functionfunction (message) {}
Pause capability.readBeh
: Functionfunction (message) {}
Read capability.resumeBeh
: Functionfunction (message) {}
Resume capability.unshiftBeh
: Functionfunction (message) {}
Unshift capability.
streams.adaptWritable(stream, options)
stream
: Stream Node.jsStream
.options
: Object (Default: {})drain
: Functionfunction () {}
Actor to receive 'drain' event.fail
: Functionfunction (error) {}
Actor to receive 'error' events.finish
: Functionfunction () {}
Actor to receive 'finish' event.
- Return: Object Capabilities wrapping the writable
stream
.
Adapts the writable stream
to Tart. Returned Capabilities are:
endBeh
: Functionfunction (message) {}
End capability.writeBeh
: Functionfunction (message) {}
Write capability.