Skip to content

further refine incremental result types #4323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

further refine incremental result types #4323

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de97191
further refine incremental result types
yaacovCR Jan 13, 2025
22f8a66
address review feedback
yaacovCR Feb 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 28 additions & 16 deletions src/execution/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,13 @@ export interface FormattedExecutionResult<

export interface ExperimentalIncrementalExecutionResults<
TInitial = ObjMap<unknown>,
TSubsequent = unknown,
TData = ObjMap<unknown>,
TIncrementalItem = unknown,
TExtensions = ObjMap<unknown>,
> {
initialResult: InitialIncrementalExecutionResult<TInitial, TExtensions>;
subsequentResults: AsyncGenerator<
SubsequentIncrementalExecutionResult<TSubsequent, TExtensions>,
SubsequentIncrementalExecutionResult<TData, TIncrementalItem, TExtensions>,
void,
void
>;
Expand All @@ -68,23 +69,29 @@ export interface FormattedInitialIncrementalExecutionResult<
}

export interface SubsequentIncrementalExecutionResult<
TData = unknown,
TData = ObjMap<unknown>,
TIncrementalItem = unknown,
TExtensions = ObjMap<unknown>,
> {
pending?: ReadonlyArray<PendingResult>;
incremental?: ReadonlyArray<IncrementalResult<TData, TExtensions>>;
incremental?: ReadonlyArray<
IncrementalResult<TData, TIncrementalItem, TExtensions>
>;
completed?: ReadonlyArray<CompletedResult>;
hasNext: boolean;
extensions?: TExtensions;
}

export interface FormattedSubsequentIncrementalExecutionResult<
TData = unknown,
TData = ObjMap<unknown>,
TIncrementalItem = unknown,
TExtensions = ObjMap<unknown>,
> {
hasNext: boolean;
pending?: ReadonlyArray<PendingResult>;
incremental?: ReadonlyArray<FormattedIncrementalResult<TData, TExtensions>>;
incremental?: ReadonlyArray<
FormattedIncrementalResult<TData, TIncrementalItem, TExtensions>
>;
completed?: ReadonlyArray<FormattedCompletedResult>;
extensions?: TExtensions;
}
Expand Down Expand Up @@ -114,41 +121,46 @@ export interface FormattedIncrementalDeferResult<
extensions?: TExtensions;
}

interface StreamItemsRecordResult<TData = ReadonlyArray<unknown>> {
interface StreamItemsRecordResult<TIncrementalItem = unknown> {
errors?: ReadonlyArray<GraphQLError>;
items: TData;
items: ReadonlyArray<TIncrementalItem>;
}

export interface IncrementalStreamResult<
TData = ReadonlyArray<unknown>,
TIncrementalItem = unknown,
TExtensions = ObjMap<unknown>,
> extends StreamItemsRecordResult<TData> {
> extends StreamItemsRecordResult<TIncrementalItem> {
id: string;
subPath?: ReadonlyArray<string | number>;
extensions?: TExtensions;
}

export interface FormattedIncrementalStreamResult<
TData = Array<unknown>,
TIncrementalItem = unknown,
TExtensions = ObjMap<unknown>,
> {
errors?: ReadonlyArray<GraphQLFormattedError>;
items: TData;
items: ReadonlyArray<TIncrementalItem>;
id: string;
subPath?: ReadonlyArray<string | number>;
extensions?: TExtensions;
}

export type IncrementalResult<TData = unknown, TExtensions = ObjMap<unknown>> =
export type IncrementalResult<
TData = ObjMap<unknown>,
TIncrementalItem = unknown,
TExtensions = ObjMap<unknown>,
> =
| IncrementalDeferResult<TData, TExtensions>
| IncrementalStreamResult<TData, TExtensions>;
| IncrementalStreamResult<TIncrementalItem, TExtensions>;

export type FormattedIncrementalResult<
TData = unknown,
TData = ObjMap<unknown>,
TIncrementalItem = unknown,
TExtensions = ObjMap<unknown>,
> =
| FormattedIncrementalDeferResult<TData, TExtensions>
| FormattedIncrementalStreamResult<TData, TExtensions>;
| FormattedIncrementalStreamResult<TIncrementalItem, TExtensions>;

export interface PendingResult {
id: string;
Expand Down
Loading