TypeGraphQL

The repository contains categorized examples demonstrating various TypeGraphQL capabilities:

Basics

• Simple usage of fields, basic types, and resolvers

Advanced

• Enums and unions
• Subscriptions (simple and Redis-based)
• Interfaces and inheritance
• Metadata extensions

Feature Usage

• Dependency injection (IoC containers and scoped containers)
• Authorization
• Validation (automatic and custom)
• Types, Resolvers, and Generic types inheritance
• Mixin classes
• Middlewares and Custom Decorators
• Query complexity

3rd Party Library Integrations

• ORMs: TypeORM (manual/synchronous and automatic/lazy relations), MikroORM, Typegoose
• Apollo Ecosystem: Apollo Federation (v1 and v2), Apollo Cache Control
• Other: GraphQL Scalars, TSyringe

Set the type field to "module" in your package.json to enable ECMAScript Modules support in your Node.js project.

{
  "type": "module"
}

In v2.0, passing a PubSub instance to the buildSchema configuration is now required. Previously, TypeGraphQL provided a default instance.

While you can use any system that implements the PubSub interface (requiring .subscribe() and .publish() methods), it is recommended to use @graphql-yoga/subscriptions to take advantage of type-safe topics via createPubSub.

import { buildSchema } from "type-graphql";
import { createPubSub } from "@graphql-yoga/subscriptions";

export const pubSub = createPubSub<{
  NOTIFICATIONS: [NotificationPayload];
  DYNAMIC_ID_TOPIC: [number, NotificationPayload];
}>();

const schema = await buildSchema({
  resolver,
  pubSub,
});

For better maintainability, separate your Azure Function handlers from your core GraphQL resolvers and services. Place handlers in a dedicated /handlers directory.

/YOUR_PROJECT
  /handlers
    /handler-graphql
      index.ts
      function.json
    /handler-SOME-OTHER-FUNCTION-1
      index.ts
      function.json

  /src
    /resolvers
      user.resolver.ts
      account.resolver.ts
    /services
      user.service.ts

  package.json
  host.json

After defining your authorization logic, you must register the authChecker when building your GraphQL schema using buildSchema.

import { buildSchema } from "type-graphql";
import { customAuthChecker } from "../auth/custom-auth-checker.ts";

const schema = await buildSchema({
  resolvers: [MyResolver],
  authChecker: customAuthChecker,
});

If you need to use something other than a class (like a GraphQLScalarType or a primitive like String) as a generic field type, you must update the factory function's parameter signature to accept these types. This allows you to pass runtime values like String or Number into the @Field decorator.

export default function PaginatedResponse<TItemsFieldValue extends object>(
  itemsFieldValue: ClassType<TItemsFieldValue> | GraphQLScalarType | String | Number | Boolean,
) {
  @ObjectType()
  abstract class PaginatedResponseClass {
    @Field(type => [itemsFieldValue])
    items: TItemsFieldValue[];

    // ... Other fields
  }
  return PaginatedResponseClass;
}

// Usage for a response containing an array of strings
@ObjectType()
class PaginatedStringsResponse extends PaginatedResponse<string>(String) {
  // ...
}

To prevent a class property from being exposed in the GraphQL schema, simply omit the @Field() decorator. This is useful for properties that are needed for internal logic or database storage but should not be publicly accessible via the API.

@ObjectType()
class Rate {
  @Field(type => Int)
  value: number;

  @Field()
  date: Date;

  // This property is stored in the DB but hidden from GraphQL
  user: User;
}

Because TypeGraphQL is a Node.js framework, attempting to use its decorated classes (e.g., for class-validator or custom methods) in a browser environment will cause build errors like ERROR in ./node_modules/fs.realpath/index.js.

To fix this, use a NormalModuleReplacementPlugin in your Webpack configuration to redirect imports from type-graphql to the type-graphql/shim. This prevents the full library from being bundled, resulting in a lighter client bundle.

module.exports = {
  // ... Rest of Webpack configuration
  plugins: [
    // ... Other existing plugins
    new webpack.NormalModuleReplacementPlugin(/type-graphql$/, resource => {
      resource.request = resource.request.replace(/type-graphql/, "type-graphql/shim");
    }),
  ];
}