Skip to content

Commit 4b00995

Browse files
committed
Improve documentation.
1 parent d5749a1 commit 4b00995

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -721,7 +721,7 @@ A [GraphQL cache](#graphql-instance-property-cache) map of [GraphQL operation](#
721721
722722
### type GraphQLCacheKey
723723
724-
A [GraphQL cache](#type-graphqlcache) key, derived from a hash of the [`fetch` options](#type-graphqlfetchoptions) of the [GraphQL operation](#type-graphqloperation) that populated the [value](#type-graphqlcachevalue).
724+
A [GraphQL cache](#type-graphqlcache) key to identify a [GraphQL cache](#type-graphqlcache) [value](#type-graphqlcachevalue). Typically created by a [GraphQL cache](#type-graphqlcache) key [creator](#type-graphqlcachekeycreator) that hashes the [`fetch` options](#type-graphqlfetchoptions) of the associated [GraphQL operation](#type-graphqloperation) using [`hashObject`](#function-hashobject).
725725
726726
**Type:** string
727727

src/universal/index.js

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,13 @@ exports.useGraphQL = require('./useGraphQL');
1818
*/
1919

2020
/**
21-
* A [GraphQL cache]{@link GraphQLCache} key, derived from a hash of the
22-
* [`fetch` options]{@link GraphQLFetchOptions} of the
23-
* [GraphQL operation]{@link GraphQLOperation} that populated the
24-
* [value]{@link GraphQLCacheValue}.
21+
* A [GraphQL cache]{@link GraphQLCache} key to identify a
22+
* [GraphQL cache]{@link GraphQLCache} [value]{@link GraphQLCacheValue}.
23+
* Typically created by a [GraphQL cache]{@link GraphQLCache} key
24+
* [creator]{@link GraphQLCacheKeyCreator} that hashes the
25+
* [`fetch` options]{@link GraphQLFetchOptions} of the associated
26+
* [GraphQL operation]{@link GraphQLOperation} using
27+
* [`hashObject`]{@link hashObject}.
2528
* @kind typedef
2629
* @name GraphQLCacheKey
2730
* @type {string}

0 commit comments

Comments
 (0)