Narrow errors type to list

webonyx · Sep 26, 2024 · 9e675b5 · 9e675b5
1 parent 87f9564
commit 9e675b5
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 15 deletions.
diff --git a/docs/class-reference.md b/docs/class-reference.md
@@ -1424,14 +1424,14 @@ locations?: array<int, array{line: int, column: int}>,
 path?: array<int, int|string>,
 extensions?: array<string, mixed>
 }
-@phpstan-type SerializableErrors array<int, SerializableError>
+@phpstan-type SerializableErrors list<SerializableError>
 @phpstan-type SerializableResult array{
 data?: array<string, mixed>,
 errors?: SerializableErrors,
 extensions?: array<string, mixed>
 }
 @phpstan-type ErrorFormatter callable(\Throwable): SerializableError
-@phpstan-type ErrorsHandler callable(array<Error> $errors, ErrorFormatter $formatter): SerializableErrors
+@phpstan-type ErrorsHandler callable(list<Error> $errors, ErrorFormatter $formatter): SerializableErrors
 
 @see \GraphQL\Tests\Executor\ExecutionResultTest
 
@@ -1455,7 +1455,7 @@ public $data;
  *
  * @api
  *
- * @var array<Error>
+ * @var list<Error>
  */
 public $errors;
 
@@ -1642,7 +1642,7 @@ will be created from the provided schema.
  *
  * @throws \Exception
  *
- * @return array<int, Error>
+ * @return list<Error>
  *
  * @api
  */

diff --git a/src/Executor/ExecutionResult.php b/src/Executor/ExecutionResult.php
@@ -20,14 +20,14 @@
  * path?: array<int, int|string>,
  * extensions?: array<string, mixed>
  * }
- * @phpstan-type SerializableErrors array<int, SerializableError>
+ * @phpstan-type SerializableErrors list<SerializableError>
  * @phpstan-type SerializableResult array{
  * data?: array<string, mixed>,
  * errors?: SerializableErrors,
  * extensions?: array<string, mixed>
  * }
  * @phpstan-type ErrorFormatter callable(\Throwable): SerializableError
- * @phpstan-type ErrorsHandler callable(array<Error> $errors, ErrorFormatter $formatter): SerializableErrors
+ * @phpstan-type ErrorsHandler callable(list<Error> $errors, ErrorFormatter $formatter): SerializableErrors
  *
  * @see \GraphQL\Tests\Executor\ExecutionResultTest
  */
@@ -50,7 +50,7 @@ class ExecutionResult implements \JsonSerializable
  *
  * @api
  *
- * @var array<Error>
+ * @var list<Error>
  */
  public array $errors = [];
 
@@ -79,7 +79,7 @@ class ExecutionResult implements \JsonSerializable
 
  /**
  * @param array<string, mixed>|null $data
- * @param array<Error> $errors
+ * @param list<Error> $errors
  * @param array<string, mixed> $extensions
  */
  public function __construct(?array $data = null, array $errors = [], array $extensions = [])

diff --git a/src/Type/SchemaValidationContext.php b/src/Type/SchemaValidationContext.php
@@ -47,7 +47,7 @@
 
 class SchemaValidationContext
 {
- /** @var array<int, Error> */
+ /** @var list<Error> */
  private array $errors = [];
 
  private Schema $schema;
@@ -60,7 +60,7 @@ public function __construct(Schema $schema)
  $this->inputObjectCircularRefs = new InputObjectCircularRefs($this);
  }
 
- /** @return array<int, Error> */
+ /** @return list<Error> */
  public function getErrors(): array
  {
  return $this->errors;

diff --git a/src/Validator/DocumentValidator.php b/src/Validator/DocumentValidator.php
@@ -90,7 +90,7 @@ class DocumentValidator
  *
  * @throws \Exception
  *
- * @return array<int, Error>
+ * @return list<Error>
  *
  * @api
  */
@@ -263,7 +263,7 @@ public static function removeRule(ValidationRule $rule): void
  *
  * @throws \Exception
  *
- * @return array<int, Error>
+ * @return list<Error>
  */
  public static function validateSDL(
  DocumentNode $documentAST,

diff --git a/src/Validator/QueryValidationContext.php b/src/Validator/QueryValidationContext.php
@@ -36,7 +36,7 @@ class QueryValidationContext implements ValidationContext
 
  protected DocumentNode $ast;
 
- /** @var array<int, Error> */
+ /** @var list<Error> */
  protected array $errors = [];
 
  private TypeInfo $typeInfo;
@@ -73,7 +73,7 @@ public function reportError(Error $error): void
  $this->errors[] = $error;
  }
 
- /** @return array<int, Error> */
+ /** @return list<Error> */
  public function getErrors(): array
  {
  return $this->errors;

diff --git a/src/Validator/ValidationContext.php b/src/Validator/ValidationContext.php
@@ -10,7 +10,7 @@ interface ValidationContext
 {
  public function reportError(Error $error): void;
 
- /** @return array<int, Error> */
+ /** @return list<Error> */
  public function getErrors(): array;
 
  public function getDocument(): DocumentNode;