Skip to content

[@types/graphql] Add generic type on ExecutionResult #26763

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

Merged
mhegazy merged 3 commits into from
Jul 3, 2018
Merged

[@types/graphql] Add generic type on ExecutionResult #26763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
46ffe35
[@types/graphql] Add generic type on ExecutionResult
clayne11 Jun 22, 2018
0c79812
Add default type to the generic so it's not a breaking change
clayne11 Jun 26, 2018
c535cb8
Don't make TData readonly
clayne11 Jun 26, 2018
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
15 changes: 10 additions & 5 deletions types/graphql/execution/execute.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,19 @@ export interface ExecutionContext {
errors: GraphQLError[];
}

export interface ExecutionResultDataDefault {
[key: string]: any
}

/**
* The result of GraphQL execution.
*
* - `errors` is included when any errors occurred as a non-empty array.
* - `data` is the result of a successful execution of the query.
*/
export interface ExecutionResult {
export interface ExecutionResult<TData = ExecutionResultDataDefault> {
errors?: ReadonlyArray<GraphQLError>;
data?: { [key: string]: any };
data?: TData;
}

export type ExecutionArgs = {
Expand All @@ -69,16 +73,16 @@ export type ExecutionArgs = {
*
* Accepts either an object with named arguments, or individual arguments.
*/
export function execute(args: ExecutionArgs): MaybePromise<ExecutionResult>;
export function execute(
export function execute<TData = ExecutionResultDataDefault>(args: ExecutionArgs): MaybePromise<ExecutionResult<TData>>;
export function execute<TData = ExecutionResultDataDefault>(
schema: GraphQLSchema,
document: DocumentNode,
rootValue?: any,
contextValue?: any,
variableValues?: Maybe<{ [key: string]: any }>,
operationName?: Maybe<string>,
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>
): MaybePromise<ExecutionResult>;
): MaybePromise<ExecutionResult<TData>>;

/**
* Given a ResponsePath (found in the `path` entry in the information provided
Expand All @@ -89,6 +93,7 @@ export function responsePathAsArray(path: ResponsePath): ReadonlyArray<string |
/**
* Given a ResponsePath and a key, return a new ResponsePath containing the
* new key.

*/
export function addPath(
prev: ResponsePath | undefined,
Expand Down
14 changes: 7 additions & 7 deletions types/graphql/graphql.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import Maybe from "./tsutils/Maybe";
import { Source } from "./language/source";
import { GraphQLFieldResolver } from "./type/definition";
import { GraphQLSchema } from "./type/schema";
import { ExecutionResult } from "./execution/execute";
import { ExecutionResult, ExecutionResultDataDefault } from "./execution/execute";

/**
* This is the primary entry point function for fulfilling GraphQL operations
Expand Down Expand Up @@ -44,30 +44,30 @@ export interface GraphQLArgs {
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
}

export function graphql(args: GraphQLArgs): Promise<ExecutionResult>;
export function graphql(
export function graphql<TData = ExecutionResultDataDefault>(args: GraphQLArgs): Promise<ExecutionResult<TData>>;
export function graphql<TData = ExecutionResultDataDefault>(
schema: GraphQLSchema,
source: Source | string,
rootValue?: any,
contextValue?: any,
variableValues?: Maybe<{ [key: string]: any }>,
operationName?: Maybe<string>,
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>
): Promise<ExecutionResult>;
): Promise<ExecutionResult<TData>>;

/**
* The graphqlSync function also fulfills GraphQL operations by parsing,
* validating, and executing a GraphQL document along side a GraphQL schema.
* However, it guarantees to complete synchronously (or throw an error) assuming
* that all field resolvers are also synchronous.
*/
export function graphqlSync(args: GraphQLArgs): ExecutionResult;
export function graphqlSync(
export function graphqlSync<TData = ExecutionResultDataDefault>(args: GraphQLArgs): ExecutionResult<TData>;
export function graphqlSync<TData = ExecutionResultDataDefault>(
schema: GraphQLSchema,
source: Source | string,
rootValue?: any,
contextValue?: any,
variableValues?: Maybe<{ [key: string]: any }>,
operationName?: Maybe<string>,
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>
): ExecutionResult;
): ExecutionResult<TData>;
1 change: 1 addition & 0 deletions types/graphql/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
// Alessio Dionisi <https://github.com/adnsio>
// Divyendu Singh <https://github.com/divyenduz>
// Brad Zacher <https://github.com/bradzacher>
// Curtis Layne <https://github.com/clayne11>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

Expand Down
14 changes: 7 additions & 7 deletions types/graphql/subscription/subscribe.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import Maybe from "../tsutils/Maybe";
import { GraphQLSchema } from "../type/schema";
import { DocumentNode } from "../language/ast";
import { GraphQLFieldResolver } from "../type/definition";
import { ExecutionResult } from "../execution/execute";
import { ExecutionResult, ExecutionResultDataDefault } from "../execution/execute";

/**
* Implements the "Subscribe" algorithm described in the GraphQL specification.
Expand All @@ -24,7 +24,7 @@ import { ExecutionResult } from "../execution/execute";
*
* Accepts either an object with named arguments, or individual arguments.
*/
export function subscribe(args: {
export function subscribe<TData = ExecutionResultDataDefault>(args: {
schema: GraphQLSchema;
document: DocumentNode;
rootValue?: any;
Expand All @@ -33,9 +33,9 @@ export function subscribe(args: {
operationName?: Maybe<string>;
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
}): Promise<AsyncIterator<ExecutionResult> | ExecutionResult>;
}): Promise<AsyncIterator<ExecutionResult<TData>> | ExecutionResult<TData>>;

export function subscribe(
export function subscribe<TData = ExecutionResultDataDefault>(
schema: GraphQLSchema,
document: DocumentNode,
rootValue?: any,
Expand All @@ -44,7 +44,7 @@ export function subscribe(
operationName?: Maybe<string>,
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>,
subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>
): Promise<AsyncIterator<ExecutionResult> | ExecutionResult>;
): Promise<AsyncIterator<ExecutionResult<TData>> | ExecutionResult<TData>>;

/**
* Implements the "CreateSourceEventStream" algorithm described in the
Expand All @@ -64,12 +64,12 @@ export function subscribe(
* or otherwise separating these two steps. For more on this, see the
* "Supporting Subscriptions at Scale" information in the GraphQL specification.
*/
export function createSourceEventStream(
export function createSourceEventStream<TData = ExecutionResultDataDefault>(
schema: GraphQLSchema,
document: DocumentNode,
rootValue?: any,
contextValue?: any,
variableValues?: { [key: string]: any },
operationName?: Maybe<string>,
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>
): Promise<AsyncIterable<any> | ExecutionResult>;
): Promise<AsyncIterable<any> | ExecutionResult<TData>>;