Skip to content

Adjust items type for IncrementalStreamResult and FormattedIncrementalStreamResult #4483

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: next
Choose a base branch
from
Open

Adjust items type for IncrementalStreamResult and FormattedIncrementalStreamResult #4483

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fb2d4d
Move array type to items property instead of TData
jerelmiller Sep 20, 2025
e8c7d64
Use ReadonlyArray
jerelmiller Sep 20, 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
10 changes: 5 additions & 5 deletions src/execution/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,13 @@ export interface FormattedIncrementalDeferResult<
extensions?: TExtensions;
}

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

export interface IncrementalStreamResult<
TData = ReadonlyArray<unknown>,
TData = unknown,
TExtensions = ObjMap<unknown>,
> extends StreamItemsRecordResult<TData> {
id: string;
Expand All @@ -129,11 +129,11 @@ export interface IncrementalStreamResult<
}

export interface FormattedIncrementalStreamResult<
TData = Array<unknown>,
TData = unknown,
TExtensions = ObjMap<unknown>,
> {
errors?: ReadonlyArray<GraphQLFormattedError>;
items: TData;
items: ReadonlyArray<TData>;
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything else seems to use ReadonlyArray, so I figured this should probably be the same instead of Array like it was before.

id: string;
subPath?: ReadonlyArray<string | number>;
extensions?: TExtensions;
Expand Down
Loading