This repository has been archived by the owner. It is now read-only.
🚀 Dojo 2 - WHATWG compliant streams.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
docs
src
tests
.editorconfig
.gitattributes
.gitignore
.travis.yml
Gruntfile.js
LICENSE
README.md
bower.json
codecov.yml
deploy_key.enc
intern.json
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

@dojo/streams

Build Status codecov npm version

An implementation of the WHATWG Streams Spec.

Usage

To use @dojo/streams, install the package along with its required peer dependencies:

npm install @dojo/streams

# peer dependencies
npm install @dojo/core
npm install @dojo/has
npm install @dojo/shim

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.

Installation

To start working with this package, clone the repository and run npm install.

In order to build the project run grunt dev or grunt dist.

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–2018 JS Foundation & contributors. New BSD license.