agubler / streams

:rocket: WHATWG compliant streams for Dojo 2.

dojo-streams

An implementation of the WHATWG Streams Spec.

Features

Two main objects in this module are ReadableStream and WritableStream.

ReadableStream

A readable stream represents a source of data, from which you can read.

const reader = readableStream.getReader();

reader.read().then(
  ({ value, done }) => {
    if (done) {
      console.log("The stream was already closed!");
    } else {
      console.log(value);
    }
  },
  e => console.error("The stream became errored and cannot be read from!", e)
);

WritableStream

A writable stream represents a destination for data, into which you can write.

const writer = writableStream.getWriter();
writer.write('data');
writer.close();

How do I contribute?

We appreciate your interest! Please see the Dojo 2 Meta Repository for the Contributing Guidelines and Style Guide.

Testing

Test cases MUST be written using Intern using the Object test interface and Assert assertion interface.

90% branch coverage MUST be provided for all code submitted to this repository, as reported by istanbul’s combined coverage results for all supported platforms.

To test locally in node run:

grunt test

To test against browsers with a local selenium server run:

grunt test:local

To test against BrowserStack or Sauce Labs run:

grunt test:browserstack

or

grunt test:saucelabs

Licensing information

© 2004–2016 Dojo Foundation & contributors. New BSD license.