Skip to content

Commit 054f26d

Browse files
committed
Mark all incremental methods as internal
1 parent 637f032 commit 054f26d

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

src/incremental/handlers/defer20220824.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ class DeferRequest<TData extends Record<string, unknown>>
6969
implements
7070
Incremental.IncrementalRequest<Defer20220824Handler.Chunk<TData>, TData>
7171
{
72+
/** @internal */
7273
public hasNext = true;
7374

7475
private errors: Array<GraphQLFormattedError> = [];
@@ -91,6 +92,7 @@ class DeferRequest<TData extends Record<string, unknown>>
9192
Object.assign(this.extensions, normalized.extensions);
9293
}
9394

95+
/** @internal */
9496
handle(
9597
// we'll get `undefined` here in case of a `no-cache` fetch policy,
9698
// so we'll continue with the last value this request had accumulated
@@ -158,6 +160,7 @@ class DeferRequest<TData extends Record<string, unknown>>
158160
export class Defer20220824Handler
159161
implements Incremental.Handler<Defer20220824Handler.Chunk<any>>
160162
{
163+
/** @internal */
161164
isIncrementalResult(
162165
result: Record<string, any>
163166
): result is
@@ -166,6 +169,7 @@ export class Defer20220824Handler
166169
return "hasNext" in result;
167170
}
168171

172+
/** @internal */
169173
extractErrors(result: ApolloLink.Result<any>) {
170174
const acc: GraphQLFormattedError[] = [];
171175
const push = ({
@@ -188,6 +192,7 @@ export class Defer20220824Handler
188192
}
189193
}
190194

195+
/** @internal */
191196
prepareRequest(request: ApolloLink.Request): ApolloLink.Request {
192197
if (hasDirectives(["defer", "stream"], request.query)) {
193198
const context = request.context ?? {};
@@ -200,6 +205,8 @@ export class Defer20220824Handler
200205

201206
return request;
202207
}
208+
209+
/** @internal */
203210
startRequest<TData extends Record<string, unknown>>(_: {
204211
query: DocumentNode;
205212
}) {

src/incremental/handlers/graphql17Alpha9.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ class IncrementalRequest<TData>
8080
implements
8181
Incremental.IncrementalRequest<GraphQL17Alpha9Handler.Chunk<TData>, TData>
8282
{
83+
/** @internal */
8384
hasNext = true;
8485

8586
private data: any = {};
@@ -95,6 +96,7 @@ class IncrementalRequest<TData>
9596
// of future stream items from already merged stream items.
9697
private streamPositions: Record<string, number> = {};
9798

99+
/** @internal */
98100
handle(
99101
chunk: GraphQL17Alpha9Handler.Chunk<TData>,
100102
cacheData: TData | DeepPartial<TData> | null | undefined = this.data

src/incremental/types.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,18 @@ export declare namespace Incremental {
1414
export interface Handler<
1515
Chunk extends Record<string, unknown> = Record<string, unknown>,
1616
> {
17+
/** @internal */
1718
isIncrementalResult: (result: ApolloLink.Result<any>) => result is Chunk;
19+
20+
/** @internal */
1821
prepareRequest: (request: ApolloLink.Request) => ApolloLink.Request;
22+
23+
/** @internal */
1924
extractErrors: (
2025
result: ApolloLink.Result<any>
2126
) => readonly GraphQLFormattedError[] | undefined | void;
27+
28+
/** @internal */
2229
startRequest: <TData extends Record<string, unknown>>(request: {
2330
query: DocumentNode;
2431
}) => IncrementalRequest<Chunk, TData>;
@@ -28,7 +35,10 @@ export declare namespace Incremental {
2835
Chunk extends Record<string, unknown>,
2936
TData,
3037
> {
38+
/** @internal */
3139
hasNext: boolean;
40+
41+
/** @internal */
3242
handle: (
3343
chunk: Chunk,
3444
cacheData: TData | DeepPartial<TData> | undefined | null

0 commit comments

Comments
 (0)