Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

GraphQLEnumType

Enum Type Definition

Some leaf values of requests and input values are Enums. GraphQL serializes Enum values as strings, however internally Enums can be represented by any kind of type, often integers.

Example:

const RGBType = new GraphQLEnumType({
  name: 'RGB',
  values: {
    RED: { value: 0 },
    GREEN: { value: 1 },
    BLUE: { value: 2 }
  }
});

Note: If a value is not provided in a definition, the name of the enum value will be used as its internal value.

class GraphQLEnumType {
constructor(config: Readonly<GraphQLEnumTypeConfig>);
private _nameLookup;
private _valueLookup;
private _values;
astNode: Maybe<EnumTypeDefinitionNode>;
description: Maybe<string>;
extensionASTNodes: ReadonlyArray<EnumTypeExtensionNode>;
extensions: Readonly<GraphQLEnumTypeExtensions>;
name: string;
get [Symbol.toStringTag](): string;
 
getValue(name: string): Maybe<GraphQLEnumValue>;
getValues(): ReadonlyArray<GraphQLEnumValue>;
parseLiteral(valueNode: ValueNode, _variables: Maybe<ObjMap<unknown>>): Maybe<any>;
parseValue(inputValue: unknown): Maybe<any>;
serialize(outputValue: unknown): Maybe<string>;
toConfig(): GraphQLEnumTypeNormalizedConfig;
toJSON(): string;
toString(): string;
}

§Constructors

§
new GraphQLEnumType(config: Readonly<GraphQLEnumTypeConfig>)
[src]

§Properties

§
_nameLookup
[src]
§
_valueLookup
[src]
§
_values
[src]
§
description: Maybe<string>
[src]
§
extensionASTNodes: ReadonlyArray<EnumTypeExtensionNode>
[src]
§
extensions: Readonly<GraphQLEnumTypeExtensions>
[src]
§
name: string
[src]
§
[Symbol.toStringTag]: string readonly
[src]

§Methods

§
getValue(name: string): Maybe<GraphQLEnumValue>
[src]
§
getValues(): ReadonlyArray<GraphQLEnumValue>
[src]
§
parseLiteral(valueNode: ValueNode, _variables: Maybe<ObjMap<unknown>>): Maybe<any>
[src]
§
parseValue(inputValue: unknown): Maybe<any>
[src]
§
serialize(outputValue: unknown): Maybe<string>
[src]
§
toConfig(): GraphQLEnumTypeNormalizedConfig
[src]
§
toJSON(): string
[src]
§
toString(): string
[src]