Skip to content

Commit

Permalink
Prettify docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ruudk authored and actions-user committed Mar 24, 2024
1 parent 6808e9f commit 653a792
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions docs/class-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ public $fieldNodes;
public $parentType;

/**
* Path to this field from the very root value.
* Path to this field from the very root value. When fields are aliased, the path includes aliases.
*
* @api
*
Expand All @@ -361,6 +361,17 @@ public $parentType;
*/
public $path;

/**
* Path to this field from the very root value. This will never include aliases.
*
* @api
*
* @var array<int, string|int>
*
* @phpstan-var Path
*/
public $unaliasedPath;

/**
* Instance of a schema used for execution.
*
Expand Down Expand Up @@ -1730,7 +1741,7 @@ function getLocations(): array
```php
/**
* Returns an array describing the path from the root value to the field which produced this error.
* Only included for execution errors.
* Only included for execution errors. When fields are aliased, the path includes aliases.
*
* @return array<int, int|string>|null
*
Expand All @@ -1739,6 +1750,18 @@ function getLocations(): array
function getPath(): ?array
```

```php
/**
* Returns an array describing the path from the root value to the field which produced this error.
* Only included for execution errors. This will never include aliases.
*
* @return array<int, int|string>|null
*
* @api
*/
function getUnaliasedPath(): ?array
```

## GraphQL\Error\Warning

Encapsulates warnings produced by the library.
Expand Down

0 comments on commit 653a792

Please sign in to comment.