Merge pull request #27 from clue-labs/docs

Author: WyriHaximus

README.md

@@ -8,11 +8,11 @@ for [ReactPHP](https://reactphp.org/).
 **Table of Contents**
 
 * [Usage](#usage)
-  * [buffer()](#buffer)
-  * [first()](#first)
-  * [all()](#all)
-  * [unwrapReadable()](#unwrapreadable)
-  * [unwrapWritable()](#unwrapwritable)
+    * [buffer()](#buffer)
+    * [first()](#first)
+    * [all()](#all)
+    * [unwrapReadable()](#unwrapreadable)
+    * [unwrapWritable()](#unwrapwritable)
 * [Install](#install)
 * [Tests](#tests)
 * [License](#license)
@@ -22,49 +22,57 @@ for [ReactPHP](https://reactphp.org/).
 This lightweight library consists only of a few simple functions.
 All functions reside under the `React\Promise\Stream` namespace.
 
-The below examples assume you use an import statement similar to this:
+The below examples assume refer to them with their fully-qualified names like this:
 
 ```php
-use React\Promise\Stream;
+React\Promise\Stream\buffer(…);
+```
 
-Stream\buffer(…);
+As of PHP 5.6+ you can also import each required function into your code like this:
+
+```php
+use function React\Promise\Stream\buffer;
+
+buffer(…);
 ```
 
-Alternatively, you can also refer to them with their fully-qualified name:
+Alternatively, you can also use an import statement similar to this:
 
 ```php
-\React\Promise\Stream\buffer(…);
+use React\Promise\Stream;
+
+Stream\buffer(…);
 ```
 
 ### buffer()
 
-The `buffer(ReadableStreamInterface<string> $stream, ?int $maxLength = null): PromiseInterface<string,Exception>` function can be used to
-create a `Promise` which resolves with the stream data buffer.
+The `buffer(ReadableStreamInterface<string> $stream, ?int $maxLength = null): PromiseInterface<string,RuntimeException>` function can be used to
+create a `Promise` which will be fulfilled with the stream data buffer.
 
 ```php
 $stream = accessSomeJsonStream();
 
-Stream\buffer($stream)->then(function ($contents) {
+React\Promise\Stream\buffer($stream)->then(function (string $contents) {
     var_dump(json_decode($contents));
 });
 ```
 
-The promise will resolve with all data chunks concatenated once the stream closes.
+The promise will be fulfilled with a `string` of all data chunks concatenated once the stream closes.
 
-The promise will resolve with an empty string if the stream is already closed.
+The promise will be fulfilled with an empty `string` if the stream is already closed.
 
-The promise will reject if the stream emits an error.
+The promise will be rejected with a `RuntimeException` if the stream emits an error.
 
-The promise will reject if it is cancelled.
+The promise will be rejected with a `RuntimeException` if it is cancelled.
 
 The optional `$maxLength` argument defaults to no limit. In case the maximum
 length is given and the stream emits more data before the end, the promise
-will be rejected with an `\OverflowException`.
+will be rejected with an `OverflowException`.
 
 ```php
 $stream = accessSomeToLargeStream();
 
-Stream\buffer($stream, 1024)->then(function ($contents) {
+React\Promise\Stream\buffer($stream, 1024)->then(function ($contents) {
     var_dump(json_decode($contents));
 }, function ($error) {
     // Reaching here when the stream buffer goes above the max size,
@@ -75,75 +83,77 @@ Stream\buffer($stream, 1024)->then(function ($contents) {
 
 ### first()
 
-The `first(ReadableStreamInterface|WritableStreamInterface $stream, string $event = 'data'): PromiseInterface<mixed,Exception>` function can be used to
-create a `Promise` which resolves once the given event triggers for the first time.
+The `first(ReadableStreamInterface|WritableStreamInterface $stream, string $event = 'data'): PromiseInterface<mixed,RuntimeException>` function can be used to
+create a `Promise` which will be fulfilled once the given event triggers for the first time.
 
 ```php
 $stream = accessSomeJsonStream();
 
-Stream\first($stream)->then(function ($chunk) {
+React\Promise\Stream\first($stream)->then(function (string $chunk) {
     echo 'The first chunk arrived: ' . $chunk;
 });
 ```
 
-The promise will resolve with whatever the first event emitted or `null` if the
-event does not pass any data.
+The promise will be fulfilled with a `mixed` value of whatever the first event
+emitted or `null` if the event does not pass any data.
 If you do not pass a custom event name, then it will wait for the first "data"
-event and resolve with a string containing the first data chunk.
+event.
+For common streams of type `ReadableStreamInterface<string>`, this means it will be
+fulfilled with a `string` containing the first data chunk.
 
-The promise will reject if the stream emits an error – unless you're waiting for
-the "error" event, in which case it will resolve.
+The promise will be rejected with a `RuntimeException` if the stream emits an error
+– unless you're waiting for the "error" event, in which case it will be fulfilled.
 
-The promise will reject once the stream closes – unless you're waiting for the
-"close" event, in which case it will resolve.
+The promise will be rejected with a `RuntimeException` once the stream closes
+– unless you're waiting for the "close" event, in which case it will be fulfilled.
 
-The promise will reject if the stream is already closed.
+The promise will be rejected with a `RuntimeException` if the stream is already closed.
 
-The promise will reject if it is cancelled.
+The promise will be rejected with a `RuntimeException` if it is cancelled.
 
 ### all()
 
-The `all(ReadableStreamInterface|WritableStreamInterface $stream, string $event = 'data'): PromiseInterface<array,Exception>` function can be used to
-create a `Promise` which resolves with an array of all the event data.
+The `all(ReadableStreamInterface|WritableStreamInterface $stream, string $event = 'data'): PromiseInterface<array,RuntimeException>` function can be used to
+create a `Promise` which will be fulfilled with an array of all the event data.
 
 ```php
 $stream = accessSomeJsonStream();
 
-Stream\all($stream)->then(function ($chunks) {
+React\Promise\Stream\all($stream)->then(function (array $chunks) {
     echo 'The stream consists of ' . count($chunks) . ' chunk(s)';
 });
 ```
 
-The promise will resolve with an array of whatever all events emitted or `null` if the
-events do not pass any data.
+The promise will be fulfilled with an `array` once the stream closes. The array
+will contain whatever all events emitted or `null` values if the events do not pass any data.
 If you do not pass a custom event name, then it will wait for all the "data"
-events and resolve with an array containing all the data chunks.
-
-The promise will resolve with an array once the stream closes.
+events.
+For common streams of type `ReadableStreamInterface<string>`, this means it will be
+fulfilled with a `string[]` array containing all the data chunk.
 
-The promise will resolve with an empty array if the stream is already closed.
+The promise will be fulfilled with an empty `array` if the stream is already closed.
 
-The promise will reject if the stream emits an error.
+The promise will be rejected with a `RuntimeException` if the stream emits an error.
 
-The promise will reject if it is cancelled.
+The promise will be rejected with a `RuntimeException` if it is cancelled.
 
 ### unwrapReadable()
 
-The `unwrapReadable(PromiseInterface<ReadableStreamInterface,Exception> $promise): ReadableStreamInterface` function can be used to
-unwrap a `Promise` which resolves with a `ReadableStreamInterface`.
+The `unwrapReadable(PromiseInterface<ReadableStreamInterface<T>,Exception> $promise): ReadableStreamInterface<T>` function can be used to
+unwrap a `Promise` which will be fulfilled with a `ReadableStreamInterface<T>`.
 
-This function returns a readable stream instance (implementing `ReadableStreamInterface`)
+This function returns a readable stream instance (implementing `ReadableStreamInterface<T>`)
 right away which acts as a proxy for the future promise resolution.
-Once the given Promise resolves with a `ReadableStreamInterface`, its data will
-be piped to the output stream.
+Once the given Promise will be fulfilled with a `ReadableStreamInterface<T>`, its
+data will be piped to the output stream.
 
 ```php
 //$promise = someFunctionWhichResolvesWithAStream();
 $promise = startDownloadStream($uri);
 
-$stream = Stream\unwrapReadable($promise);
+$stream = React\Promise\Stream\unwrapReadable($promise);
 
-$stream->on('data', function ($data) {
+$stream->on('data', function (string $data) {
     echo $data;
 });
 
@@ -159,7 +169,7 @@ an `error` event and close:
 ```php
 $promise = startDownloadStream($invalidUri);
 
-$stream = Stream\unwrapReadable($promise);
+$stream = React\Promise\Stream\unwrapReadable($promise);
 
 $stream->on('error', function (Exception $error) {
     echo 'Error: ' . $error->getMessage();
@@ -168,17 +178,16 @@ $stream->on('error', function (Exception $error) {
 
 The given `$promise` SHOULD be pending, i.e. it SHOULD NOT be fulfilled or rejected
 at the time of invoking this function.
-If the given promise is already settled and does not resolve with an
-instance of `ReadableStreamInterface`, then you will not be able to receive
-the `error` event.
+If the given promise is already settled and does not fulfill with an instance of
+`ReadableStreamInterface`, then you will not be able to receive the `error` event.
 
 You can `close()` the resulting stream at any time, which will either try to
 `cancel()` the pending promise or try to `close()` the underlying stream.
 
 ```php
 $promise = startDownloadStream($uri);
 
-$stream = Stream\unwrapReadable($promise);
+$stream = React\Promise\Stream\unwrapReadable($promise);
 
 $loop->addTimer(2.0, function () use ($stream) {
     $stream->close();
@@ -187,20 +196,22 @@ $loop->addTimer(2.0, function () use ($stream) {
 
 ### unwrapWritable()
 
-The `unwrapWritable(PromiseInterface<WritableStreamInterface,Exception> $promise): WritableStreamInterface` function can be used to
-unwrap a `Promise` which resolves with a `WritableStreamInterface`.
+The `unwrapWritable(PromiseInterface<WritableStreamInterface<T>,Exception> $promise): WritableStreamInterface<T>` function can be used to
+unwrap a `Promise` which will be fulfilled with a `WritableStreamInterface<T>`.
 
-This function returns a writable stream instance (implementing `WritableStreamInterface`)
+This function returns a writable stream instance (implementing `WritableStreamInterface<T>`)
 right away which acts as a proxy for the future promise resolution.
-Any writes to this instance will be buffered in memory for when the promise resolves.
-Once the given Promise resolves with a `WritableStreamInterface`, any data you
-have written to the proxy will be forwarded transparently to the inner stream.
+Any writes to this instance will be buffered in memory for when the promise will
+be fulfilled.
+Once the given Promise will be fulfilled with a `WritableStreamInterface<T>`, any
+data you have written to the proxy will be forwarded transparently to the inner
+stream.
 
 ```php
 //$promise = someFunctionWhichResolvesWithAStream();
 $promise = startUploadStream($uri);
 
-$stream = Stream\unwrapWritable($promise);
+$stream = React\Promise\Stream\unwrapWritable($promise);
 
 $stream->write('hello');
 $stream->end('world');
@@ -217,7 +228,7 @@ an `error` event and close:
 ```php
 $promise = startUploadStream($invalidUri);
 
-$stream = Stream\unwrapWritable($promise);
+$stream = React\Promise\Stream\unwrapWritable($promise);
 
 $stream->on('error', function (Exception $error) {
     echo 'Error: ' . $error->getMessage();
@@ -226,17 +237,16 @@ $stream->on('error', function (Exception $error) {
 
 The given `$promise` SHOULD be pending, i.e. it SHOULD NOT be fulfilled or rejected
 at the time of invoking this function.
-If the given promise is already settled and does not resolve with an
-instance of `WritableStreamInterface`, then you will not be able to receive
-the `error` event.
+If the given promise is already settled and does not fulfill with an instance of
+`WritableStreamInterface`, then you will not be able to receive the `error` event.
 
 You can `close()` the resulting stream at any time, which will either try to
 `cancel()` the pending promise or try to `close()` the underlying stream.
 
 ```php
 $promise = startUploadStream($uri);
 
-$stream = Stream\unwrapWritable($promise);
+$stream = React\Promise\Stream\unwrapWritable($promise);
 
 $loop->addTimer(2.0, function () use ($stream) {
     $stream->close();
@@ -245,7 +255,7 @@ $loop->addTimer(2.0, function () use ($stream) {
 
 ## Install
 
-The recommended way to install this library is [through Composer](https://getcomposer.org).
+The recommended way to install this library is [through Composer](https://getcomposer.org/).
 [New to Composer?](https://getcomposer.org/doc/00-intro.md)
 
 This project follows [SemVer](https://semver.org/).
@@ -260,12 +270,12 @@ See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
 This project aims to run on any platform and thus does not require any PHP
 extensions and supports running on legacy PHP 5.3 through current PHP 8+ and
 HHVM.
-It's *highly recommended to use PHP 7+* for this project.
+It's *highly recommended to use the latest supported PHP version* for this project.
 
 ## Tests
 
 To run the test suite, you first need to clone this repo and then install all
-dependencies [through Composer](https://getcomposer.org):
+dependencies [through Composer](https://getcomposer.org/):
 
 ```bash
 $ composer install
@@ -274,7 +284,7 @@ $ composer install
 To run the test suite, go to the project root and run:
 
 ```bash
-$ php vendor/bin/phpunit
+$ vendor/bin/phpunit
 ```
 
 ## License