Adds type hinting

This commit is contained in:
luke
2021-06-18 22:01:16 +01:00
parent 4b55de27f1
commit 27de6106ab
4 changed files with 16 additions and 10 deletions

View File

@ -12,9 +12,12 @@ use Pest\Expectation;
trait Expectable trait Expectable
{ {
/** /**
* @template TValue
*
* Creates a new expectation. * Creates a new expectation.
* *
* @param mixed $value * @param TValue $value
* @return Expectation<TValue>
*/ */
public function expect($value): Expectation public function expect($value): Expectation
{ {

View File

@ -10,14 +10,14 @@ namespace Pest\Concerns;
trait RetrievesValues trait RetrievesValues
{ {
/** /**
* @template TValue * @template TRetrievableValue
* *
* Safely retrieve the value at the given key from an object or array. * Safely retrieve the value at the given key from an object or array.
* *
* @param array<string, TValue>|object $value * @param array<string, TRetrievableValue>|object $value
* @param TValue|null $default * @param TRetrievableValue|null $default
* *
* @return TValue|null * @return TRetrievableValue|null
*/ */
private function retrieve(string $key, $value, $default = null) private function retrieve(string $key, $value, $default = null)
{ {

View File

@ -16,6 +16,8 @@ use SebastianBergmann\Exporter\Exporter;
/** /**
* @internal * @internal
* *
* @template TValue
*
* @property Expectation $not Creates the opposite expectation. * @property Expectation $not Creates the opposite expectation.
* @property Each $each Creates an expectation on each element on the traversable value. * @property Each $each Creates an expectation on each element on the traversable value.
*/ */
@ -47,7 +49,7 @@ final class Expectation
/** /**
* Creates a new expectation. * Creates a new expectation.
* *
* @param mixed $value * @param TValue $value
*/ */
public function __construct($value) public function __construct($value)
{ {
@ -57,7 +59,8 @@ final class Expectation
/** /**
* Creates a new expectation. * Creates a new expectation.
* *
* @param mixed $value * @param TValue $value
* @return Expectation<TValue>
*/ */
public function and($value): Expectation public function and($value): Expectation
{ {
@ -722,7 +725,7 @@ final class Expectation
* *
* @param array<int, mixed> $parameters * @param array<int, mixed> $parameters
* *
* @return mixed * @return HigherOrderExpectation|mixed
*/ */
public function __call(string $method, array $parameters) public function __call(string $method, array $parameters)
{ {

View File

@ -66,7 +66,7 @@ final class HigherOrderExpectation
/** /**
* Dynamically calls methods on the class with the given arguments. * Dynamically calls methods on the class with the given arguments.
* *
* @param array<int|string, mixed> $arguments * @param array $arguments
*/ */
public function __call(string $name, array $arguments): self public function __call(string $name, array $arguments): self
{ {
@ -115,7 +115,7 @@ final class HigherOrderExpectation
/** /**
* Performs the given assertion with the current expectation. * Performs the given assertion with the current expectation.
* *
* @param array<int|string, mixed> $arguments * @param array $arguments
*/ */
private function performAssertion(string $name, array $arguments): self private function performAssertion(string $name, array $arguments): self
{ {