Merge pull request #3608 from chentsulin/patch-1

ObservableQuery.currentResult return value docs in comment
apollographql · Jul 10, 2018 · 13a5116 · 13a5116
2 parents 2cd8072 + cd80513
commit 13a5116
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/packages/apollo-client/src/core/ObservableQuery.ts b/packages/apollo-client/src/core/ObservableQuery.ts
@@ -153,7 +153,7 @@ export class ObservableQuery<
    * Return the result of the query from the local cache as well as some fetching status
    * `loading` and `networkStatus` allow to know if a request is in flight
    * `partial` lets you know if the result from the local cache is complete or partial
-   * @return {result: Object, loading: boolean, networkStatus: number, partial: boolean}
+   * @return {data: Object, error: ApolloError, loading: boolean, networkStatus: number, partial: boolean}
    */
   public currentResult(): ApolloCurrentResult<TData> {
     if (this.isTornDown) {