Pothos

A library for creating GraphQL schemas in TypeScript using a strongly typed...

GraphQL Schema

hayes/pothos pothos-graphql.dev @pothos/core

README

Pothos GraphQL

Pothos is a plugin based GraphQL schema builder for typescript.

It makes building graphql schemas in typescript easy, fast and enjoyable. The core of Pothos adds 0

overhead at runtime, and has graphql as its only dependency.

Pothos is the most type-safe way to build GraphQL schemas in typescript, and by leveraging type

inference and typescript's powerful type system Pothos requires very few manual type definitions and

no code generation.

Pothos has a unique and powerful plugin system that makes every plugin feel like its features are

built into the core library. Plugins can extend almost any part of the API by adding new options or

methods that can take full advantage of the Pothos type system.

Hello, World

```typescript
import { createYoga } from 'graphql-yoga';
import { createServer } from 'node:http';
import SchemaBuilder from '@pothos/core';
const builder = new SchemaBuilder({});
builder.queryType({
fields: (t) => ({
hello: t.string({
args: {
name: t.arg.string(),
},
resolve: (parent, { name }) => `hello, ${name || 'World'}`,
}),
}),
});
const yoga = createYoga({
schema: builder.toSchema(),
});
const server = createServer(yoga);
server.listen(3000);
```

What sets Pothos apart

- Pothos was built from the start to leverage typescript for best-in-class type-safety.

- Pothos has a clear separation between the shape of your external GraphQL API, and the internal

representation of your data.

- Pothos comes with a large plugin ecosystem that provides a wide variety of features while

maintaining great interoperability between plugins.

- Pothos does not depend on code-generation or experimental decorators for type-safety.

- Pothos has been designed to work at every scale from small prototypes to huge Enterprise

applications, and is in use at some of the largest tech companies including Airbnb and Netflix.

Plugins that make Pothos even better

- [Auth](https://pothos-graphql.dev/docs/plugins/scope-auth)

Add global, type level, or field level authorization checks to your schema

- [Complexity](https://pothos-graphql.dev/docs/plugins/complexity)

A plugin for defining and limiting complexity of queries

- [Directives](https://pothos-graphql.dev/docs/plugins/directives)

Integrate with existing schema graphql directives in a type-safe way.

- [Errors](https://pothos-graphql.dev/docs/plugins/errors)

A plugin for easily including error types in your GraphQL schema and hooking up error types to

resolvers.

- [Dataloader](https://pothos-graphql.dev/docs/plugins/dataloader)

Quickly define data-loaders for your types and fields to avoid n+1 queries.

- [Mocks](https://pothos-graphql.dev/docs/plugins/mocks)

Add mock resolvers for easier testing

- [Prisma](https://pothos-graphql.dev/docs/plugins/prisma)

A plugin for more efficient integration with prisma that can help solve n+1 issues and more

efficienty resolve queries

- [Relay](https://pothos-graphql.dev/docs/plugins/relay)

Easy to use builder methods for defining relay style nodes and connections, and helpful utilities

for cursor based pagination.

- [Simple Objects](https://pothos-graphql.dev/docs/plugins/simple-objects)

Define simple object types without resolvers or manual type definitions.

- [Smart Subscriptions](https://pothos-graphql.dev/docs/plugins/smart-subscriptions)

Make any part of your graph subscribable to get live updates as your data changes.

- [Sub-Graph](https://pothos-graphql.dev/docs/plugins/sub-graph)

Build multiple subsets of your graph to easily share code between internal and external APIs.

- [Tracing](https://pothos-graphql.dev/docs/plugins/tracing)

Add tracing for resolver execution, with support for opentelemetry, newrelic, century, logging,

and custom tracers

- [Validation](https://pothos-graphql.dev/docs/plugins/validation)

Validating your inputs and arguments

- [With-Input](https://pothos-graphql.dev/docs/plugins/with-input)

Define fields with inline input objects