Skip to content

Commit 38d52de

Browse files
committed
Update api report
1 parent a5b22b5 commit 38d52de

2 files changed

Lines changed: 55 additions & 9 deletions

File tree

.api-reports/api-report-incremental.api.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -197,16 +197,28 @@ export namespace Incremental {
197197
// (undocumented)
198198
export interface IncrementalRequest<Chunk extends Record<string, unknown>, TData> {
199199
// (undocumented)
200-
getPendingType?: (id: string) => "defer" | "stream";
200+
getPendingWithInfo?: () => Array<PendingItemWithInfo>;
201201
// (undocumented)
202202
handle: (cacheData: TData | DeepPartial<TData> | undefined | null, chunk: Chunk) => FormattedExecutionResult<TData>;
203203
// (undocumented)
204204
hasNext: boolean;
205-
// (undocumented)
206-
pending?: Array<Incremental.PendingResult>;
207205
}
208206
// (undocumented)
209207
export type Path = ReadonlyArray<string | number>;
208+
// @internal @deprecated (undocumented)
209+
export interface PendingDeferResultWithInfo {
210+
// (undocumented)
211+
delivered: boolean;
212+
// (undocumented)
213+
path: Incremental.Path;
214+
// (undocumented)
215+
type: "defer";
216+
}
217+
// Warning: (ae-incompatible-release-tags) The symbol "PendingItemWithInfo" is marked as @public, but its signature references "Incremental" which is marked as @internal
218+
// Warning: (ae-incompatible-release-tags) The symbol "PendingItemWithInfo" is marked as @public, but its signature references "Incremental" which is marked as @internal
219+
//
220+
// (undocumented)
221+
export type PendingItemWithInfo = PendingDeferResultWithInfo | PendingStreamResultWithInfo;
210222
// (undocumented)
211223
export interface PendingResult {
212224
// (undocumented)
@@ -217,6 +229,13 @@ export namespace Incremental {
217229
path: Incremental.Path;
218230
}
219231
// @internal @deprecated (undocumented)
232+
export interface PendingStreamResultWithInfo {
233+
// (undocumented)
234+
path: Incremental.Path;
235+
// (undocumented)
236+
type: "stream";
237+
}
238+
// @internal @deprecated (undocumented)
220239
export interface StartRequestOptions {
221240
// (undocumented)
222241
query: DocumentNode;
@@ -233,13 +252,19 @@ export namespace Incremental {
233252
// @public (undocumented)
234253
class IncrementalRequest<TData> implements Incremental.IncrementalRequest<GraphQL17Alpha9Handler.Chunk<TData>, TData> {
235254
// (undocumented)
236-
getPendingType(id: string): "defer" | "stream";
255+
getPendingWithInfo(): ({
256+
type: "stream";
257+
path: Incremental.Path;
258+
delivered?: undefined;
259+
} | {
260+
type: "defer";
261+
delivered: boolean;
262+
path: Incremental.Path;
263+
})[];
237264
// (undocumented)
238265
handle(cacheData: TData | DeepPartial<TData> | null | undefined, chunk: GraphQL17Alpha9Handler.Chunk<TData>): FormattedExecutionResult<TData>;
239266
// (undocumented)
240267
hasNext: boolean;
241-
// (undocumented)
242-
get pending(): GraphQL17Alpha9Handler.PendingResult[];
243268
}
244269

245270
// @public (undocumented)

.api-reports/api-report.api.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1598,17 +1598,31 @@ namespace Incremental {
15981598
}
15991599
// (undocumented)
16001600
interface IncrementalRequest<Chunk extends Record<string, unknown>, TData> {
1601+
// Warning: (ae-forgotten-export) The symbol "Incremental" needs to be exported by the entry point index.d.ts
1602+
//
16011603
// (undocumented)
1602-
getPendingType?: (id: string) => "defer" | "stream";
1604+
getPendingWithInfo?: () => Array<PendingItemWithInfo>;
16031605
// (undocumented)
16041606
handle: (cacheData: TData | DeepPartial<TData> | undefined | null, chunk: Chunk) => FormattedExecutionResult<TData>;
16051607
// (undocumented)
16061608
hasNext: boolean;
1607-
// (undocumented)
1608-
pending?: Array<Incremental.PendingResult>;
16091609
}
16101610
// (undocumented)
16111611
type Path = ReadonlyArray<string | number>;
1612+
// @internal @deprecated (undocumented)
1613+
interface PendingDeferResultWithInfo {
1614+
// (undocumented)
1615+
delivered: boolean;
1616+
// (undocumented)
1617+
path: Incremental.Path;
1618+
// (undocumented)
1619+
type: "defer";
1620+
}
1621+
// Warning: (ae-forgotten-export) The symbol "Incremental" needs to be exported by the entry point index.d.ts
1622+
// Warning: (ae-forgotten-export) The symbol "Incremental" needs to be exported by the entry point index.d.ts
1623+
//
1624+
// (undocumented)
1625+
type PendingItemWithInfo = PendingDeferResultWithInfo | PendingStreamResultWithInfo;
16121626
// (undocumented)
16131627
interface PendingResult {
16141628
// (undocumented)
@@ -1619,6 +1633,13 @@ namespace Incremental {
16191633
path: Incremental.Path;
16201634
}
16211635
// @internal @deprecated (undocumented)
1636+
interface PendingStreamResultWithInfo {
1637+
// (undocumented)
1638+
path: Incremental.Path;
1639+
// (undocumented)
1640+
type: "stream";
1641+
}
1642+
// @internal @deprecated (undocumented)
16221643
interface StartRequestOptions {
16231644
// (undocumented)
16241645
query: DocumentNode;

0 commit comments

Comments
 (0)