README.md

pothos-plugin-result

A Pothos plugin for easily creating GraphQL schemas that reflect the results of specific actions.

Usage

Install

$ yarn add pothos-plugin-result

Setup

import ResultPlugin from "pothos-plugin-result";

const builder = new SchemaBuilder({
  plugins: [ResultPlugin],
});

Example

builder.mutationType({
  fields: (t) => ({
    createPost: t.result({
      type: {
        createdPost: PostRef,
      },
      args: {
        title: t.arg.string({ required: true }),
      },
      resolve: (_root, { title }) => {
        return {
          createdPost: {
            id: "1",
            title,
          },
        };
      },
    }),

    // @pothos/plugin-with-input plugin required.
    updatePost: t.resultWithInput({
      type: {
        updatedPost: PostRef,
      },
      input: {
        postId: t.input.id({ required: true }),
        title: t.input.string({ required: true }),
      },
      resolve: (_root, { input }) => {
        return {
          updatedPost: {
            id: input.postId.toString(),
            title: input.title,
          },
        };
      },
    }),
  }),
});

You can get the GraphQL schema as output below:

type Mutation {
  createPost(title: String!): MutationCreatePostResult!
  updatePost(input: MutationUpdatePostInput!): MutationUpdatePostResult!
}

type MutationCreatePostResult {
  createdPost: Post
}

input MutationUpdatePostInput {
  postId: ID!
  title: String!
}

type MutationUpdatePostResult {
  updatedPost: Post
}

Limitation

• Only can be used in mutation type.
• The types that can be created are limited to objects. Array types are not supported. Fields contained in the type are nullable.

License

MIT