Overview

GiraphQL
Search…
GiraphQL
main
Overview
GiraphQL
GiraphQL - A plugin based GraphQL schema builder for typescript
GiraphQL makes writing graphql schemas in typescript easy, fast and enjoyable. The core of GiraphQL adds 0 overhead at runtime, and has graphql as its only dependency.
By leaning heavily on typescripts ability to infer types, GiraphQL is the most type-safe way of writing GraphQL schemas in typescript/node while requiring very few manual type definitions and no code generation.
GiraphQL 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 GiraphQLs type system.
Hello, World
1
import { ApolloServer } from 'apollo-server';
2
import SchemaBuilder from '@giraphql/core';
3
​
4
const builder = new SchemaBuilder({});
5
​
6
builder.queryType({
7
  fields: (t) => ({
8
    hello: t.string({
9
      args: {
10
        name: t.arg.string(),
11
      },
12
      resolve: (parent, { name }) => `hello, ${name || 'World'}`,
13
    }),
14
  }),
15
});
16
​
17
new ApolloServer({
18
  schema: builder.toSchema({}),
19
}).listen(3000);
Copied!
Plugins that make GiraphQL even better
​Scope Auth​
Add global, type level, or field level authorization checks to your schema
​Validation​
Validating your inputs and arguments
​Dataloader​
Quickly define data-loaders for your types and fields to avoid n+1 queries.
​Relay​
Easy to use builder methods for defining relay style nodes and connections, and helpful utilities
for cursor based pagination.
​Simple Objects​
Define simple object types without resolvers or manual type definitions.
​Mocks​
Add mock resolver for easier testing
​Sub-Graph​
Build multiple subsets of your graph to easily share code between internal and external APIs.
​Directives​
Integrate with existing schema graphql directives in a type-safe way.
​Smart Subscriptions​
Make any part of your graph subscribable to get live updates as your data changes.
​Errors​
A plugin for easily including error types in your GraphQL schema and hooking up error types to resolvers.
​Prisma​
A plugin for more efficient integration with prisma that can help solve n+1 issues and more efficienty resolve queries
Guide
Last modified 1mo ago
Copy link
Contents
GiraphQL - A plugin based GraphQL schema builder for typescript
Hello, World
Plugins that make GiraphQL even better