Skip to content

Commit c5190d4

Browse files
add docs and regenerate for GraphQLResultError
1 parent 76690ad commit c5190d4

3 files changed

Lines changed: 31 additions & 0 deletions

File tree

Sources/Apollo/GraphQLExecutor.swift

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,14 @@ struct GraphQLResolveInfo {
2424
}
2525
}
2626

27+
/// An error which has occurred in processing a GraphQLResult
2728
public struct GraphQLResultError: Error, LocalizedError {
2829
let path: ResponsePath
30+
31+
/// The error that occurred during parsing.
2932
public let underlying: Error
3033

34+
/// A description of the error which includes the path where the error occurred.
3135
public var errorDescription: String? {
3236
return "Error at path \"\(path))\": \(underlying)"
3337
}

docs/source/api/Apollo/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- [GraphQLFragmentSpread](structs/GraphQLFragmentSpread/)
3030
- [GraphQLHTTPResponseError](structs/GraphQLHTTPResponseError/)
3131
- [GraphQLResult](structs/GraphQLResult/)
32+
- [GraphQLResultError](structs/GraphQLResultError/)
3233
- [GraphQLTypeCase](structs/GraphQLTypeCase/)
3334
- [GraphQLTypeCondition](structs/GraphQLTypeCondition/)
3435
- [GraphQLVariable](structs/GraphQLVariable/)
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
**STRUCT**
2+
3+
# `GraphQLResultError`
4+
5+
```swift
6+
public struct GraphQLResultError: Error, LocalizedError
7+
```
8+
9+
> An error which has occurred in processing a GraphQLResult
10+
11+
## Properties
12+
### `underlying`
13+
14+
```swift
15+
public let underlying: Error
16+
```
17+
18+
> The error that occurred during parsing.
19+
20+
### `errorDescription`
21+
22+
```swift
23+
public var errorDescription: String?
24+
```
25+
26+
> A description of the error which includes the path where the error occurred.

0 commit comments

Comments
 (0)