docs: fix return signature of peekRequest (emberjs#9161)

Baltazore · Dec 21, 2023 · ef62094 · ef62094
1 parent 022ec9d
commit ef62094
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/packages/core-types/src/cache.ts b/packages/core-types/src/cache.ts
@@ -144,9 +144,13 @@ export interface Cache {
    * Peek the Cache for the existing request data associated with
    * a cacheable request
    *
+   * This is effectively the reverse of `put` for a request in
+   * that it will return the the request, response, and content
+   * whereas `peek` will return just the `content`.
+   *
    * @method peekRequest
    * @param {StableDocumentIdentifier}
-   * @return {StableDocumentIdentifier | null}
+   * @return {StructuredDocument<ResourceDocument> | null}
    * @public
    */
   peekRequest(identifier: StableDocumentIdentifier): StructuredDocument<ResourceDocument> | null;

diff --git a/packages/json-api/src/-private/cache.ts b/packages/json-api/src/-private/cache.ts
@@ -481,11 +481,15 @@ export default class JSONAPICache implements Cache {
 
   /**
    * Peek the Cache for the existing request data associated with
-   * a cacheable request
+   * a cacheable request.
+   *
+   * This is effectively the reverse of `put` for a request in
+   * that it will return the the request, response, and content
+   * whereas `peek` will return just the `content`.
    *
    * @method peekRequest
    * @param {StableDocumentIdentifier}
-   * @return {StableDocumentIdentifier | null}
+   * @return {StructuredDocument<ResourceDocument> | null}
    * @public
    */
   peekRequest(identifier: StableDocumentIdentifier): StructuredDocument<ResourceDocument> | null {