Nonsense Parser Microframework

    @dojo/streams
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0-alpha.2 • Public • Published

    @dojo/streams

    Build Status codecov npm version

    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.

    Keywords

    none

    Install

    npm i @dojo/streams

    DownloadsWeekly Downloads

    2

    Version

    2.0.0-alpha.2

    License

    BSD-3-Clause

    Last publish

    Collaborators

    • rorticus
    • dylans
    • agubler
    • matt-gadd
    • tomdye
    • bitpshr