Miss any of our Open RFC calls?Watch the recordings here! »

nodert-streams

0.0.5 • Public • Published

nodert-streams

Turns a WinRT stream (Wrapped using NodeRT) into a node.js stream. For more information on NodeRT, take a look at: https://github.com/NodeRT/NodeRT

You can download this module from NPM by running the following cmd:

npm install nodert-streams

If you have cloned the git repo (and not downloaded thm module from NPM) run the following command from inside the directory:

node-gyp rebuild

(For both of the above commands, make sure that node-gyp and all of its perquisites are installed)

API:

  • Exposes an InputStream object which can be initiated by passing a WinRT input stream, this object behaves like a readable nodejs stream.
  • Exposes an OutputStream object which can be initiated by passing a WinRT input stream, this object behaves like a writeable nodejs stream.

Prerequisites:

In order to use nodert-streams, please make sure first to generate and compile the following NodeRT module and place it in a node_modules directory near by:

  • windows.storage.streams

Here is an example of using nodert-streams for piping contents of a file to stdout:

var streams = require('windows.storage.streams');
var storage = require('windows.storage');
var nodert_streams = require('nodert-streams');
var StorageFile = storage.StorageFile;
 
// open a file from the documents library
storage.KnownFolders.documentsLibrary.getFileAsync('document.txt', function(err, file) {
  if (err) {
    return console.info(err);
  }
  // call openAsync in order to retrieve the stream
  file.openAsync(storage.FileAccessMode.read, function(err, fileStream) {
    if (err) {
      return console.info(err);
    }
    // convert the winrt stream to a node.js stream
    var nodeStream = streams.InputStream(fileStream);
    // pipe the stream to the stdout
    nodeStream.pipe(process.stdout);
  });
});

Install

npm i nodert-streams

DownloadsWeekly Downloads

1

Version

0.0.5

License

Apache 2.0

Last publish

Collaborators

  • avatar