@envelop/types 4.0.0 → 4.0.1-alpha-20230625183843-67123c76
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/typings/graphql.d.cts +17 -0
- package/typings/graphql.d.ts +17 -0
- package/typings/hooks.d.cts +2 -2
- package/typings/hooks.d.ts +2 -2
package/package.json
CHANGED
package/typings/graphql.d.cts
CHANGED
|
@@ -61,4 +61,21 @@ export interface ExecutionResult<TData = ObjMap<unknown>, TExtensions = ObjMap<u
|
|
|
61
61
|
data?: TData | null;
|
|
62
62
|
extensions?: TExtensions;
|
|
63
63
|
}
|
|
64
|
+
export interface IncrementalDeferResult<TData = Record<string, unknown>, TExtensions = Record<string, unknown>> extends ExecutionResult<TData, TExtensions> {
|
|
65
|
+
path?: ReadonlyArray<string | number>;
|
|
66
|
+
label?: string;
|
|
67
|
+
}
|
|
68
|
+
export interface IncrementalStreamResult<TData = Array<unknown>, TExtensions = Record<string, unknown>> {
|
|
69
|
+
errors?: ReadonlyArray<any>;
|
|
70
|
+
items?: TData | null;
|
|
71
|
+
path?: ReadonlyArray<string | number>;
|
|
72
|
+
label?: string;
|
|
73
|
+
extensions?: TExtensions;
|
|
74
|
+
}
|
|
75
|
+
export type IncrementalResult<TData = Record<string, unknown>, TExtensions = Record<string, unknown>> = IncrementalDeferResult<TData, TExtensions> | IncrementalStreamResult<TData, TExtensions>;
|
|
76
|
+
export interface IncrementalExecutionResult<TData = Record<string, unknown>, TExtensions = Record<string, unknown>> extends ExecutionResult<TData, TExtensions> {
|
|
77
|
+
hasNext: boolean;
|
|
78
|
+
incremental?: ReadonlyArray<IncrementalResult<TData, TExtensions>>;
|
|
79
|
+
extensions?: TExtensions;
|
|
80
|
+
}
|
|
64
81
|
export {};
|
package/typings/graphql.d.ts
CHANGED
|
@@ -61,4 +61,21 @@ export interface ExecutionResult<TData = ObjMap<unknown>, TExtensions = ObjMap<u
|
|
|
61
61
|
data?: TData | null;
|
|
62
62
|
extensions?: TExtensions;
|
|
63
63
|
}
|
|
64
|
+
export interface IncrementalDeferResult<TData = Record<string, unknown>, TExtensions = Record<string, unknown>> extends ExecutionResult<TData, TExtensions> {
|
|
65
|
+
path?: ReadonlyArray<string | number>;
|
|
66
|
+
label?: string;
|
|
67
|
+
}
|
|
68
|
+
export interface IncrementalStreamResult<TData = Array<unknown>, TExtensions = Record<string, unknown>> {
|
|
69
|
+
errors?: ReadonlyArray<any>;
|
|
70
|
+
items?: TData | null;
|
|
71
|
+
path?: ReadonlyArray<string | number>;
|
|
72
|
+
label?: string;
|
|
73
|
+
extensions?: TExtensions;
|
|
74
|
+
}
|
|
75
|
+
export type IncrementalResult<TData = Record<string, unknown>, TExtensions = Record<string, unknown>> = IncrementalDeferResult<TData, TExtensions> | IncrementalStreamResult<TData, TExtensions>;
|
|
76
|
+
export interface IncrementalExecutionResult<TData = Record<string, unknown>, TExtensions = Record<string, unknown>> extends ExecutionResult<TData, TExtensions> {
|
|
77
|
+
hasNext: boolean;
|
|
78
|
+
incremental?: ReadonlyArray<IncrementalResult<TData, TExtensions>>;
|
|
79
|
+
extensions?: TExtensions;
|
|
80
|
+
}
|
|
64
81
|
export {};
|
package/typings/hooks.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ExecuteFunction, ExecutionArgs, ExecutionResult, ParseFunction, SubscribeFunction, ValidateFunction, ValidateFunctionParameter } from './graphql.cjs';
|
|
1
|
+
import { ExecuteFunction, ExecutionArgs, ExecutionResult, IncrementalExecutionResult, ParseFunction, SubscribeFunction, ValidateFunction, ValidateFunctionParameter } from './graphql.cjs';
|
|
2
2
|
import { Plugin } from './plugin.cjs';
|
|
3
3
|
import { AsyncIterableIteratorOrValue, Maybe, PromiseOrValue } from './utils.cjs';
|
|
4
4
|
export type DefaultArgs = Record<string, unknown>;
|
|
@@ -271,7 +271,7 @@ export type OnExecuteDoneHookResultOnNextHookPayload<ContextType> = {
|
|
|
271
271
|
/**
|
|
272
272
|
* The execution result.
|
|
273
273
|
*/
|
|
274
|
-
result: ExecutionResult;
|
|
274
|
+
result: IncrementalExecutionResult | ExecutionResult;
|
|
275
275
|
/**
|
|
276
276
|
* Replace the execution result with a new execution result.
|
|
277
277
|
*/
|
package/typings/hooks.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ExecuteFunction, ExecutionArgs, ExecutionResult, ParseFunction, SubscribeFunction, ValidateFunction, ValidateFunctionParameter } from './graphql.js';
|
|
1
|
+
import { ExecuteFunction, ExecutionArgs, ExecutionResult, IncrementalExecutionResult, ParseFunction, SubscribeFunction, ValidateFunction, ValidateFunctionParameter } from './graphql.js';
|
|
2
2
|
import { Plugin } from './plugin.js';
|
|
3
3
|
import { AsyncIterableIteratorOrValue, Maybe, PromiseOrValue } from './utils.js';
|
|
4
4
|
export type DefaultArgs = Record<string, unknown>;
|
|
@@ -271,7 +271,7 @@ export type OnExecuteDoneHookResultOnNextHookPayload<ContextType> = {
|
|
|
271
271
|
/**
|
|
272
272
|
* The execution result.
|
|
273
273
|
*/
|
|
274
|
-
result: ExecutionResult;
|
|
274
|
+
result: IncrementalExecutionResult | ExecutionResult;
|
|
275
275
|
/**
|
|
276
276
|
* Replace the execution result with a new execution result.
|
|
277
277
|
*/
|