Skip to content

Commit cfe0a19

Browse files
committed
Mark streamInfo and getPendingWithInfo as internal
1 parent fd47624 commit cfe0a19

3 files changed

Lines changed: 10 additions & 9 deletions

File tree

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -197,13 +197,13 @@ export namespace Incremental {
197197
}
198198
// (undocumented)
199199
export interface IncrementalRequest<Chunk extends Record<string, unknown>, TData> {
200-
// (undocumented)
200+
// @internal @deprecated (undocumented)
201201
getPendingWithInfo?: () => Array<PendingItemWithInfo>;
202202
// (undocumented)
203203
handle: (cacheData: TData | DeepPartial<TData> | undefined | null, chunk: Chunk) => FormattedExecutionResult<TData>;
204204
// (undocumented)
205205
hasNext: boolean;
206-
// (undocumented)
206+
// @internal @deprecated (undocumented)
207207
readonly streamInfo?: StreamInfoTrie;
208208
}
209209
// (undocumented)
@@ -217,10 +217,7 @@ export namespace Incremental {
217217
// (undocumented)
218218
type: "defer";
219219
}
220-
// Warning: (ae-incompatible-release-tags) The symbol "PendingItemWithInfo" is marked as @public, but its signature references "Incremental" which is marked as @internal
221-
// Warning: (ae-incompatible-release-tags) The symbol "PendingItemWithInfo" is marked as @public, but its signature references "Incremental" which is marked as @internal
222-
//
223-
// (undocumented)
220+
// @internal @deprecated (undocumented)
224221
export type PendingItemWithInfo = PendingDeferResultWithInfo | PendingStreamResultWithInfo;
225222
// (undocumented)
226223
export interface PendingResult {

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1600,13 +1600,13 @@ namespace Incremental {
16001600
interface IncrementalRequest<Chunk extends Record<string, unknown>, TData> {
16011601
// Warning: (ae-forgotten-export) The symbol "Incremental" needs to be exported by the entry point index.d.ts
16021602
//
1603-
// (undocumented)
1603+
// @internal @deprecated (undocumented)
16041604
getPendingWithInfo?: () => Array<PendingItemWithInfo>;
16051605
// (undocumented)
16061606
handle: (cacheData: TData | DeepPartial<TData> | undefined | null, chunk: Chunk) => FormattedExecutionResult<TData>;
16071607
// (undocumented)
16081608
hasNext: boolean;
1609-
// (undocumented)
1609+
// @internal @deprecated (undocumented)
16101610
readonly streamInfo?: StreamInfoTrie;
16111611
}
16121612
// (undocumented)
@@ -1623,7 +1623,7 @@ namespace Incremental {
16231623
// Warning: (ae-forgotten-export) The symbol "Incremental" needs to be exported by the entry point index.d.ts
16241624
// Warning: (ae-forgotten-export) The symbol "Incremental" needs to be exported by the entry point index.d.ts
16251625
//
1626-
// (undocumented)
1626+
// @internal @deprecated (undocumented)
16271627
type PendingItemWithInfo = PendingDeferResultWithInfo | PendingStreamResultWithInfo;
16281628
// (undocumented)
16291629
interface PendingResult {

src/incremental/types.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,12 @@ export declare namespace Incremental {
4141
TData,
4242
> {
4343
hasNext: boolean;
44+
45+
/** @internal */
4446
readonly streamInfo?: StreamInfoTrie;
47+
/** @internal */
4548
getPendingWithInfo?: () => Array<PendingItemWithInfo>;
49+
4650
handle: (
4751
cacheData: TData | DeepPartial<TData> | undefined | null,
4852
chunk: Chunk

0 commit comments

Comments
 (0)