Introduction

The API has been carefully designed with the following goals in mind:

  1. Type-Safety by default
  2. Readability
  3. Developer ergonomics
  4. Playing nicely with Prettier formatting

The API has evolved over the last few months of early development and internal use is unlikely to undergo major structural changes.

That is, before you open a GitHub issue or pull-request with a suggested change to the API, ensure that it meets all four of those criteria listed above and be able to explain why a change is necessary.

Each public API is documented below, feel free to open a PR with more examples/clarification:

Resolving: Inline Function

One common idiom in GraphQL is exposing fields that mask or rename the property name on the backing object. GraphQL Nexus makes this simple by allowing a function as the second parameter to any built-in scalar resolver function.

1const User = objectType({
2 name: 'User',
3 definition(t) {
4 t.id('id', o => o.user_id)
5 t.string('name', o => o.user_name)
6 t.string('description', o => o.user_description)
7 },
8})
Edit this page on Github