Skip to content

Commit ab3e813

Browse files
committed
Add a note not to conflict with other projects
1 parent c96d6d6 commit ab3e813

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

src/type/definition.d.ts

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,10 @@ export function getNamedType(type: GraphQLType): GraphQLNamedType;
271271
*/
272272
export type Thunk<T> = (() => T) | T;
273273

274+
/**
275+
* It's strongly recommended that you prefix each added attribute's name with an
276+
* identifier unique to your project to avoid conflicts with other projects.
277+
*/
274278
export interface GraphQLScalarTypeExtensions {
275279
[attributeName: string]: any;
276280
}
@@ -342,6 +346,10 @@ export interface GraphQLScalarTypeConfig<TInternal, TExternal> {
342346
extensionASTNodes?: Maybe<ReadonlyArray<ScalarTypeExtensionNode>>;
343347
}
344348

349+
/**
350+
* It's strongly recommended that you prefix each added attribute's name with an
351+
* identifier unique to your project to avoid conflicts with other projects.
352+
*/
345353
export interface GraphQLObjectTypeExtensions {
346354
[attributeName: string]: any;
347355
}
@@ -460,6 +468,10 @@ export interface GraphQLResolveInfo {
460468
readonly variableValues: { [variableName: string]: any };
461469
}
462470

471+
/**
472+
* It's strongly recommended that you prefix each added attribute's name with an
473+
* identifier unique to your project to avoid conflicts with other projects.
474+
*/
463475
export interface GraphQLFieldExtensions {
464476
[attributeName: string]: any;
465477
}
@@ -483,6 +495,10 @@ export type GraphQLFieldConfigArgumentMap = {
483495
[key: string]: GraphQLArgumentConfig;
484496
};
485497

498+
/**
499+
* It's strongly recommended that you prefix each added attribute's name with an
500+
* identifier unique to your project to avoid conflicts with other projects.
501+
*/
486502
export interface GraphQLArgumentExtensions {
487503
[attributeName: string]: any;
488504
}
@@ -531,6 +547,10 @@ export type GraphQLFieldMap<TSource, TContext> = {
531547
[key: string]: GraphQLField<TSource, TContext>;
532548
};
533549

550+
/**
551+
* It's strongly recommended that you prefix each added attribute's name with an
552+
* identifier unique to your project to avoid conflicts with other projects.
553+
*/
534554
export interface GraphQLInterfaceTypeExtensions {
535555
[attributeName: string]: any;
536556
}
@@ -593,6 +613,10 @@ export interface GraphQLInterfaceTypeConfig<TSource, TContext> {
593613
extensionASTNodes?: Maybe<ReadonlyArray<InterfaceTypeExtensionNode>>;
594614
}
595615

616+
/**
617+
* It's strongly recommended that you prefix each added attribute's name with an
618+
* identifier unique to your project to avoid conflicts with other projects.
619+
*/
596620
export interface GraphQLUnionTypeExtensions {
597621
[attributeName: string]: any;
598622
}
@@ -657,6 +681,10 @@ export interface GraphQLUnionTypeConfig<TSource, TContext> {
657681
extensionASTNodes?: Maybe<ReadonlyArray<UnionTypeExtensionNode>>;
658682
}
659683

684+
/**
685+
* It's strongly recommended that you prefix each added attribute's name with an
686+
* identifier unique to your project to avoid conflicts with other projects.
687+
*/
660688
export interface GraphQLEnumTypeExtensions {
661689
[attributeName: string]: any;
662690
}
@@ -722,6 +750,10 @@ export type GraphQLEnumValueConfigMap = {
722750
[key: string]: GraphQLEnumValueConfig;
723751
};
724752

753+
/**
754+
* It's strongly recommended that you prefix each added attribute's name with an
755+
* identifier unique to your project to avoid conflicts with other projects.
756+
*/
725757
export interface GraphQLEnumValueExtensions {
726758
[attributeName: string]: any;
727759
}
@@ -744,6 +776,10 @@ export interface GraphQLEnumValue {
744776
astNode?: Maybe<EnumValueDefinitionNode>;
745777
}
746778

779+
/**
780+
* It's strongly recommended that you prefix each added attribute's name with an
781+
* identifier unique to your project to avoid conflicts with other projects.
782+
*/
747783
export interface GraphQLInputObjectTypeExtensions {
748784
[attributeName: string]: any;
749785
}
@@ -798,6 +834,10 @@ export interface GraphQLInputObjectTypeConfig {
798834
extensionASTNodes?: Maybe<ReadonlyArray<InputObjectTypeExtensionNode>>;
799835
}
800836

837+
/**
838+
* It's strongly recommended that you prefix each added attribute's name with an
839+
* identifier unique to your project to avoid conflicts with other projects.
840+
*/
801841
export interface GraphQLInputFieldExtensions {
802842
[attributeName: string]: any;
803843
}

src/type/directives.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ import { GraphQLFieldConfigArgumentMap, GraphQLArgument } from './definition';
1414
export function isDirective(directive: any): directive is GraphQLDirective;
1515
export function assertDirective(directive: any): GraphQLDirective;
1616

17+
/**
18+
* It's strongly recommended that you prefix each added attribute's name with an
19+
* identifier unique to your project to avoid conflicts with other projects.
20+
*/
1721
export interface GraphQLDirectiveExtensions {
1822
[attributeName: string]: any;
1923
}

src/type/schema.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ import {
1919
export function isSchema(schema: any): schema is GraphQLSchema;
2020
export function assertSchema(schema: any): GraphQLSchema;
2121

22+
/**
23+
* It's strongly recommended that you prefix each added attribute's name with an
24+
* identifier unique to your project to avoid conflicts with other projects.
25+
*/
2226
export interface GraphQLSchemaExtensions {
2327
[attributeName: string]: any;
2428
}

0 commit comments

Comments
 (0)