Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add docs
Browse files Browse the repository at this point in the history
JoviDeCroock committed Sep 26, 2023
1 parent cd170f0 commit 2da5e0a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions packages/core/src/types.ts
Original file line number Diff line number Diff line change
@@ -140,7 +140,14 @@ export interface IncrementalPayload {
* items.
*/
path?: readonly (string | number)[];
/** An id pointing at an entry in the "pending" set of deferred results
*
* @remarks
* When we resolve this id it will give us the path to the deferred Fragment, this
* can be afterwards combined with the subPath to get the eventual location of the data.
*/
id?: string;
/** A path array from the defer/stream fragment to the location of our data. */
subPath?: readonly (string | number)[];
/** Data to patch into the result data at the given `path`.
*
@@ -179,6 +186,8 @@ export interface ExecutionResult {
*
* @remarks
* This was nely introduced in the defer/stream spec iteration of June 2023 https://github.com/graphql/defer-stream-wg/discussions/69
* Pending can be present on both Incremental as well as normal execution results, the presence of pending on an incremental
* result points at a nested deferred/streamed fragment.
*/
pending?: Array<{ path: readonly (string | number)[]; id: string }>;
/** Incremental patches to be applied to a previous result as part of "Incremental Delivery".

0 comments on commit 2da5e0a

Please sign in to comment.