Logo for jsDocs.io

graphql-middleware

  • Version 6.1.35
  • Published
  • 60.6 kB
  • 2 dependencies
  • MIT license

Install

npm i graphql-middleware
yarn add graphql-middleware
pnpm add graphql-middleware

Overview

GraphQL Middleware done right!

Index

Functions

Classes

Interfaces

Type Aliases

Functions

function applyMiddleware

applyMiddleware: <TSource = any, TContext = any, TArgs = any>(
    schema: GraphQLSchema,
    ...middlewares: (
        | IMiddleware<TSource, TContext, TArgs>
        | IMiddlewareGenerator<TSource, TContext, TArgs>
    )[]
) => GraphQLSchemaWithFragmentReplacements;

  • Parameter schema

    Parameter middlewares

    Apply middleware to resolvers and return generated schema.

function applyMiddlewareToDeclaredResolvers

applyMiddlewareToDeclaredResolvers: <TSource = any, TContext = any, TArgs = any>(
    schema: GraphQLSchema,
    ...middlewares: (
        | IMiddleware<TSource, TContext, TArgs>
        | IMiddlewareGenerator<TSource, TContext, TArgs>
    )[]
) => GraphQLSchemaWithFragmentReplacements;

  • Parameter schema

    Parameter middlewares

    Apply middleware to declared resolvers and return new schema.

function middleware

middleware: <TSource = any, TContext = any, TArgs = any>(
    generator: IMiddlewareGeneratorConstructor<TSource, TContext, TArgs>
) => IMiddlewareGenerator<TSource, TContext, TArgs>;

    Classes

    class IMiddlewareGenerator

    class IMiddlewareGenerator<TSource, TContext, TArgs> {}

      constructor

      constructor(
          generator: IMiddlewareGeneratorConstructor<TSource, TContext, TArgs>
      );

        method generate

        generate: (schema: GraphQLSchema) => IMiddleware<TSource, TContext, TArgs>;

          class MiddlewareError

          class MiddlewareError extends Error {}

            Interfaces

            interface FragmentReplacement

            interface FragmentReplacement {}

              property field

              field: string;

                property fragment

                fragment: string;

                  interface IMiddlewareFieldMap

                  interface IMiddlewareFieldMap<TSource = any, TContext = any, TArgs = any> {}

                    index signature

                    [key: string]: IMiddlewareFunction<TSource, TContext, TArgs>;

                      interface IMiddlewareTypeMap

                      interface IMiddlewareTypeMap<TSource = any, TContext = any, TArgs = any> {}

                        index signature

                        [key: string]:
                            | IMiddlewareFunction<TSource, TContext, TArgs>
                            | IMiddlewareFieldMap<TSource, TContext, TArgs>;

                          Type Aliases

                          type IMiddleware

                          type IMiddleware<TSource = any, TContext = any, TArgs = any> =
                              | IMiddlewareFunction<TSource, TContext, TArgs>
                              | IMiddlewareTypeMap<TSource, TContext, TArgs>;

                            type IMiddlewareFunction

                            type IMiddlewareFunction<TSource = any, TContext = any, TArgs = any> =
                                | IMiddlewareWithOptions<TSource, TContext, TArgs>
                                | IMiddlewareResolver<TSource, TContext, TArgs>;

                              type IMiddlewareGeneratorConstructor

                              type IMiddlewareGeneratorConstructor<TSource = any, TContext = any, TArgs = any> = (
                                  schema: GraphQLSchema
                              ) => IMiddleware<TSource, TContext, TArgs>;

                                Package Files (5)

                                Dependencies (2)

                                Dev Dependencies (19)

                                Peer Dependencies (1)

                                Badge

                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/graphql-middleware.

                                • Markdown
                                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/graphql-middleware)
                                • HTML
                                  <a href="https://www.jsdocs.io/package/graphql-middleware"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>