refactor: rename enum "decorator" to registerEnumType

Author: MichalLytek

docs/enums.md

@@ -26,9 +26,9 @@ enum Direction {
 ```
 Then, we should mark the enums with `@GraphQLEnumType()` decorator. However TypeScript's decorators works only with classes, so we need to mark the enums manually by calling the register function and providing the enum name for GraphQL:
 ```ts
-import { registerEnum } from "type-graphql";
+import { registerEnumType } from "type-graphql";
 
-registerEnum(Direction, {
+registerEnumType(Direction, {
   name: "Direction", // this one is mandatory
   description: "The basic directions", // this one is optional
 });

examples/enums-and-unions/difficulty.enum.ts

@@ -1,4 +1,4 @@
-import { registerEnum } from "../../src";
+import { registerEnumType } from "../../src";
 
 export enum Difficulty {
   Beginner,
@@ -8,7 +8,7 @@ export enum Difficulty {
   Masterchef,
 }
 
-registerEnum(Difficulty, {
+registerEnumType(Difficulty, {
   name: "Difficulty",
   description: "All possible preparation difficulty levels",
 });

src/decorators/enums.ts

@@ -1,7 +1,7 @@
 import { EnumConfig } from "../types/decorators";
 import { MetadataStorage } from "../metadata/metadata-storage";
 
-export function registerEnum<T extends object>(enumObj: T, enumConfig: EnumConfig) {
+export function registerEnumType<T extends object>(enumObj: T, enumConfig: EnumConfig) {
   MetadataStorage.registerEnumDefinition({
     enumObj,
     name: enumConfig.name,

src/decorators/index.ts

@@ -4,7 +4,7 @@ export { Args } from "./Args";
 export { ArgsType, ArgsType as GraphQLArgsType } from "./ArgsType";
 export { Authorized } from "./Authorized";
 export { Ctx } from "./Ctx";
-export { registerEnum } from "./enums";
+export { registerEnumType } from "./enums";
 export { Field } from "./Field";
 export { FieldResolver } from "./FieldResolver";
 // export { InputType } from "./InputType";

tests/functional/enums.ts

@@ -13,7 +13,7 @@ import {
 import { getSchemaInfo } from "../helpers/getSchemaInfo";
 import { getInnerInputFieldType, getInnerTypeOfNullableType } from "../helpers/getInnerFieldType";
 import { MetadataStorage } from "../../src/metadata/metadata-storage";
-import { Field, InputType, Query, Arg, registerEnum } from "../../src";
+import { Field, InputType, Query, Arg, registerEnumType } from "../../src";
 
 describe("Enums", () => {
   let schemaIntrospection: IntrospectionSchema;
@@ -29,14 +29,14 @@ describe("Enums", () => {
       Three,
       Four,
     }
-    registerEnum(NumberEnum, { name: "NumberEnum" });
+    registerEnumType(NumberEnum, { name: "NumberEnum" });
 
     enum StringEnum {
       One = "ONE",
       Two = "TWO",
       Three = "THREE",
     }
-    registerEnum(StringEnum, { name: "StringEnum", description: "custom string enum" });
+    registerEnumType(StringEnum, { name: "StringEnum", description: "custom string enum" });
 
     @InputType()
     class NumberEnumInput {

tests/functional/unions.ts

@@ -24,7 +24,7 @@ import {
   InputType,
   Query,
   Arg,
-  registerEnum,
+  registerEnumType,
   createUnionType,
 } from "../../src";