dojo/streams

Name: streams

Owner: Dojo

Description: :rocket: Dojo 2 - WHATWG compliant streams.

Created: 2016-12-02 14:30:23.0

Updated: 2018-04-28 15:02:19.0

Pushed: 2018-04-28 15:02:18.0

Homepage: http://dojo.io

Size: 366

Language: TypeScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

@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:

install @dojo/streams

er dependencies
install @dojo/core
install @dojo/has
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.

t reader = readableStream.getReader();

er.read().then(
 value, done }) => {
if (done) {
  console.log("The stream was already closed!");
} else {
  console.log(value);
}

=> 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.

t writer = writableStream.getWriter();
er.write('data');
er.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.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.