Skip to content

Commit bf97398

Browse files
committed
Improve documentation
1 parent f3d59ec commit bf97398

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

src/UnwrapReadableStream.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
use React\Stream\WritableStreamInterface;
99
use React\Stream\Util;
1010
use React\Promise\CancellablePromiseInterface;
11+
use InvalidArgumentException;
1112

1213
/**
1314
* @internal
@@ -19,10 +20,9 @@ class UnwrapReadableStream extends EventEmitter implements ReadableStreamInterfa
1920
private $closed = false;
2021

2122
/**
22-
* unwrap a `Promise` which resolves with a `ReadableStreamInterface`.
23+
* Instantiate new unwrapped readable stream for given `Promise` which resolves with a `ReadableStreamInterface`.
2324
*
2425
* @param PromiseInterface $promise Promise<ReadableStreamInterface, Exception>
25-
* @return ReadableStreamInterface
2626
*/
2727
public function __construct(PromiseInterface $promise)
2828
{
@@ -32,7 +32,7 @@ public function __construct(PromiseInterface $promise)
3232
$this->promise = $promise->then(
3333
function ($stream) {
3434
if (!($stream instanceof ReadableStreamInterface)) {
35-
throw new \InvalidArgumentException('Not a readable stream');
35+
throw new InvalidArgumentException('Not a readable stream');
3636
}
3737
return $stream;
3838
}

src/functions.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
namespace Clue\React\Promise\Stream;
44

5-
use React\Stream\ReadableStream;
65
use React\Stream\ReadableStreamInterface;
76
use React\Promise;
87
use React\Promise\PromiseInterface;
9-
use React\Promise\CancellablePromiseInterface;
108

119
/**
1210
* Creates a `Promise` which resolves with the stream data buffer

0 commit comments

Comments
 (0)