README.md #1

  • //
  • guest/
  • perforce_software/
  • helix-web-services/
  • main/
  • source/
  • client-javascript/
  • node_modules/
  • stream-combiner2/
  • node_modules/
  • readable-stream/
  • README.md
  • Markdown
  • View
  • Commits
  • Open Download .zip Download (2 KB)

readable-stream

Node-core v5.9.1 streams for userland Build Status

NPM NPM

Sauce Test Status

npm install --save readable-stream

Node-core streams for userland

This package is a mirror of the Streams2 and Streams3 implementations in Node-core, including documentation.

If you want to guarantee a stable streams base, regardless of what version of Node you, or the users of your libraries are using, use readable-stream only and avoid the "stream" module in Node-core, for background see this blogpost.

As of version 2.0.0 readable-stream uses semantic versioning.

Streams WG Team Members

  • Chris Dickinson (@chrisdickinson) <[email protected]>
    • Release GPG key: 9554F04D7259F04124DE6B476D5A82AC7E37093B
  • Calvin Metcalf (@calvinmetcalf) <[email protected]>
    • Release GPG key: F3EF5F62A87FC27A22E643F714CE4FF5015AA242
  • Rod Vagg (@rvagg) <[email protected]>
    • Release GPG key: DD8F2338BAE7501E3DD5AC78C273792F7D83545D
  • Sam Newman (@sonewman) <[email protected]>
  • Mathias Buus (@mafintosh) <[email protected]>
  • Domenic Denicola (@domenic) <[email protected]>
# readable-stream

***Node-core v5.9.1 streams for userland*** [![Build Status](https://travis-ci.org/nodejs/readable-stream.svg?branch=master)](https://travis-ci.org/nodejs/readable-stream)


[![NPM](https://nodei.co/npm/readable-stream.png?downloads=true&downloadRank=true)](https://nodei.co/npm/readable-stream/)
[![NPM](https://nodei.co/npm-dl/readable-stream.png?&months=6&height=3)](https://nodei.co/npm/readable-stream/)


[![Sauce Test Status](https://saucelabs.com/browser-matrix/readable-stream.svg)](https://saucelabs.com/u/readable-stream)

```bash
npm install --save readable-stream
```

***Node-core streams for userland***

This package is a mirror of the Streams2 and Streams3 implementations in
Node-core, including [documentation](doc/stream.markdown).

If you want to guarantee a stable streams base, regardless of what version of
Node you, or the users of your libraries are using, use **readable-stream** *only* and avoid the *"stream"* module in Node-core, for background see [this blogpost](http://r.va.gg/2014/06/why-i-dont-use-nodes-core-stream-module.html).

As of version 2.0.0 **readable-stream** uses semantic versioning.  

# Streams WG Team Members

* **Chris Dickinson** ([@chrisdickinson](https://github.com/chrisdickinson)) &lt;[email protected]&gt;
  - Release GPG key: 9554F04D7259F04124DE6B476D5A82AC7E37093B
* **Calvin Metcalf** ([@calvinmetcalf](https://github.com/calvinmetcalf)) &lt;[email protected]&gt;
  - Release GPG key: F3EF5F62A87FC27A22E643F714CE4FF5015AA242
* **Rod Vagg** ([@rvagg](https://github.com/rvagg)) &lt;[email protected]&gt;
  - Release GPG key: DD8F2338BAE7501E3DD5AC78C273792F7D83545D
* **Sam Newman** ([@sonewman](https://github.com/sonewman)) &lt;[email protected]&gt;
* **Mathias Buus** ([@mafintosh](https://github.com/mafintosh)) &lt;[email protected]&gt;
* **Domenic Denicola** ([@domenic](https://github.com/domenic)) &lt;[email protected]&gt;
# Change User Description Committed
#1 19553 swellard Move and rename clients
//guest/perforce_software/helix-web-services/main/source/clients/2016.1.0/javascript/node_modules/stream-combiner2/node_modules/readable-stream/README.md
#2 19053 tjuricek Rebuild JavaScript Client SDK.

The JavaScript client now is a "typed" approach that tends to be similar in approach to the other clients, based on the swagger definition for the platform version.

Importantly, client SDK tests are individual scripts (that run under node) that are actually controlled via TestNG. This approach now lets us use a consistent test reporting format so we can at least collect reports from each of the jobs.

The documentation is still in progress, that I want to validate as the tests are generated.
#1 18810 tjuricek First-pass at JavaScript client SDK.

JavaScript requires Node with Gulp to "browserfy" the library. It's the easiest way I found to use the swagger-js project; bundle up a wrapping method.

There is no JavaScript reference guide. The swagger-js doesn't really document what they do very well, actually.

Overall I'm not particularly impressed by swagger-js, it was hard to even figure out what the right method syntax was. We may want to invest time in doing it better.

This required setting CORS response headers, which are currently defaulted to a fairly insecure setting.