Skip to content

TS: switch to Record utility type #2985

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.

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions src/error/GraphQLError.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export class GraphQLError extends Error {
positions?: Maybe<ReadonlyArray<number>>,
path?: Maybe<ReadonlyArray<string | number>>,
originalError?: Maybe<Error>,
extensions?: Maybe<{ [key: string]: unknown }>,
extensions?: Maybe<Record<string, unknown>>,
);

/**
Expand Down Expand Up @@ -77,7 +77,7 @@ export class GraphQLError extends Error {
/**
* Extension fields to add to the formatted error.
*/
readonly extensions: { [key: string]: unknown } | undefined;
readonly extensions: Record<string, unknown> | undefined;
}

/**
Expand Down
16 changes: 8 additions & 8 deletions src/execution/execute.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export interface ExecutionContext {
contextValue: unknown;
fragments: ObjMap<FragmentDefinitionNode>;
operation: OperationDefinitionNode;
variableValues: { [key: string]: unknown };
variableValues: Record<string, unknown>;
fieldResolver: GraphQLFieldResolver<any, any>;
typeResolver: GraphQLTypeResolver<any, any>;
errors: Array<GraphQLError>;
Expand All @@ -69,8 +69,8 @@ export interface ExecutionContext {
* - `extensions` is reserved for adding non-standard properties.
*/
export interface ExecutionResult<
TData = { [key: string]: any },
TExtensions = { [key: string]: any }
TData = Record<string, any>,
TExtensions = Record<string, any>
> {
errors?: ReadonlyArray<GraphQLError>;
// TS_SPECIFIC: TData. Motivation: https://github.com/graphql/graphql-js/pull/2490#issuecomment-639154229
Expand All @@ -79,8 +79,8 @@ export interface ExecutionResult<
}

export interface FormattedExecutionResult<
TData = { [key: string]: any },
TExtensions = { [key: string]: any }
TData = Record<string, any>,
TExtensions = Record<string, any>
> {
errors?: ReadonlyArray<GraphQLFormattedError>;
// TS_SPECIFIC: TData. Motivation: https://github.com/graphql/graphql-js/pull/2490#issuecomment-639154229
Expand All @@ -93,7 +93,7 @@ export interface ExecutionArgs {
document: DocumentNode;
rootValue?: unknown;
contextValue?: unknown;
variableValues?: Maybe<{ [key: string]: unknown }>;
variableValues?: Maybe<Record<string, unknown>>;
operationName?: Maybe<string>;
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
Expand Down Expand Up @@ -127,7 +127,7 @@ export function executeSync(args: ExecutionArgs): ExecutionResult;
export function assertValidExecutionArguments(
schema: GraphQLSchema,
document: DocumentNode,
rawVariableValues: Maybe<{ [key: string]: unknown }>,
rawVariableValues: Maybe<Record<string, unknown>>,
): void;

/**
Expand All @@ -143,7 +143,7 @@ export function buildExecutionContext(
document: DocumentNode,
rootValue: unknown,
contextValue: unknown,
rawVariableValues: Maybe<{ [key: string]: unknown }>,
rawVariableValues: Maybe<Record<string, unknown>>,
operationName: Maybe<string>,
fieldResolver: Maybe<GraphQLFieldResolver<unknown, unknown>>,
typeResolver?: Maybe<GraphQLTypeResolver<unknown, unknown>>,
Expand Down
8 changes: 4 additions & 4 deletions src/execution/values.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { GraphQLField } from '../type/definition';

type CoercedVariableValues =
| { errors: ReadonlyArray<GraphQLError>; coerced?: never }
| { errors?: never; coerced: { [key: string]: unknown } };
| { errors?: never; coerced: Record<string, unknown> };

/**
* Prepares an object map of variableValues of the correct type based on the
Expand All @@ -28,7 +28,7 @@ type CoercedVariableValues =
export function getVariableValues(
schema: GraphQLSchema,
varDefNodes: ReadonlyArray<VariableDefinitionNode>,
inputs: { [key: string]: unknown },
inputs: Record<string, unknown>,
options?: { maxErrors?: number },
): CoercedVariableValues;

Expand All @@ -44,7 +44,7 @@ export function getArgumentValues(
def: GraphQLField<unknown, unknown> | GraphQLDirective,
node: FieldNode | DirectiveNode,
variableValues?: Maybe<ObjMap<unknown>>,
): { [key: string]: unknown };
): Record<string, unknown>;

/**
* Prepares an object map of argument values given a directive definition
Expand All @@ -63,4 +63,4 @@ export function getDirectiveValues(
readonly directives?: ReadonlyArray<DirectiveNode>;
},
variableValues?: Maybe<ObjMap<unknown>>,
): undefined | { [key: string]: unknown };
): undefined | Record<string, unknown>;
2 changes: 1 addition & 1 deletion src/graphql.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export interface GraphQLArgs {
source: string | Source;
rootValue?: unknown;
contextValue?: unknown;
variableValues?: Maybe<{ [key: string]: unknown }>;
variableValues?: Maybe<Record<string, unknown>>;
operationName?: Maybe<string>;
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
Expand Down
2 changes: 1 addition & 1 deletion src/subscription/subscribe.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export function createSourceEventStream(
document: DocumentNode,
rootValue?: unknown,
contextValue?: unknown,
variableValues?: { [key: string]: unknown },
variableValues?: Record<string, unknown>,
operationName?: Maybe<string>,
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>,
): Promise<AsyncIterable<unknown> | ExecutionResult>;
12 changes: 4 additions & 8 deletions src/type/definition.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ export type GraphQLIsTypeOfFn<TSource, TContext> = (
export type GraphQLFieldResolver<
TSource,
TContext,
TArgs = { [argName: string]: any }
TArgs = Record<string, any>
> = (
source: TSource,
args: TArgs,
Expand All @@ -482,7 +482,7 @@ export interface GraphQLResolveInfo {
readonly fragments: ObjMap<FragmentDefinitionNode>;
readonly rootValue: unknown;
readonly operation: OperationDefinitionNode;
readonly variableValues: { [variableName: string]: unknown };
readonly variableValues: Record<string, unknown>;
}

/**
Expand All @@ -508,7 +508,7 @@ export interface GraphQLFieldExtensions<
export interface GraphQLFieldConfig<
TSource,
TContext,
TArgs = { [argName: string]: any }
TArgs = Record<string, any>
> {
description?: Maybe<string>;
type: GraphQLOutputType;
Expand Down Expand Up @@ -550,11 +550,7 @@ export type GraphQLFieldConfigMap<TSource, TContext> = ObjMap<
GraphQLFieldConfig<TSource, TContext>
>;

export interface GraphQLField<
TSource,
TContext,
TArgs = { [key: string]: any }
> {
export interface GraphQLField<TSource, TContext, TArgs = Record<string, any>> {
name: string;
description: Maybe<string>;
type: GraphQLOutputType;
Expand Down