Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write about @oneOf in the graphql-js documentation #4290

Merged
merged 2 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ words:
- tailwindcss
- svgr
- ruru
- oneof

# used as href anchors
- graphqlerror
Expand Down
1 change: 1 addition & 0 deletions website/pages/_meta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const meta = {
title: 'Advanced Guides',
},
'constructing-types': '',
'oneof-input-objects': 'OneOf input objects',
'defer-stream': '',
'-- 3': {
type: 'separator',
Expand Down
91 changes: 91 additions & 0 deletions website/pages/oneof-input-objects.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: OneOf input objects
---

import { Tabs } from 'nextra/components';

Some inputs will behave differently depending on what input we choose. Let's look at the case for
a field named `product`, we can fetch a `Product` by either its `id` or its `name`. Currently we'd
make a tradeoff for this by introducing two arguments that are both nullable, now if both are passed
as null (or both non-null) we'd have to handle that in code - the type system wouldn't indicate that exactly one was required. To fix this, the `@oneOf` directive was introduced so we
can create this "exactly one option" constraint without sacrificing the strictly typed nature of our GraphQL Schema.

<Tabs items={['SDL', 'Code']}>
<Tabs.Tab>
```js
const schema = buildSchema(`
type Product {
id: ID!
name: String!
}

input ProductLocation {
aisleNumber: Int!
shelfNumber: Int!
positionOnShelf: Int!
}

input ProductSpecifier @oneOf {
id: ID
name: String
location: ProductLocation
}

type Query {
product(by: ProductSpecifier!): Product
}
`);
```
</Tabs.Tab>
<Tabs.Tab>
```js
const Product = new GraphQLObjectType({
name: 'Product',
fields: {
id: {
type: new GraphQLNonNull(GraphQLID),
},
name: {
type: new GraphQLNonNull(GraphQLString),
},
},
});

const ProductLocation = new GraphQLInputObjectType({
name: 'ProductLocation',
isOneOf: true,
fields: {
aisleNumber: { type: GraphQLInt },
shelfNumber: { type: GraphQLInt },
positionOnShelf: { type: GraphQLInt },
},
});

const ProductSpecifier = new GraphQLInputObjectType({
name: 'ProductSpecifier',
isOneOf: true,
fields: {
id: { type: GraphQLID },
name: { type: GraphQLString },
location: { type: ProductLocation },
},
});

const schema = new GraphQLSchema({
query: new GraphQLObjectType({
name: 'Query',
fields: {
product: {
type: Product,
args: { by: { type: ProductSpecifier } },
},
},
}),
});
```
</Tabs.Tab>
</Tabs>

It doesn't matter whether you have 2 or more inputs here, all that matters is
that your user will have to specify one, and only one, for this input to be valid.
The values are not limited to scalars, lists and other input object types are also allowed.
Loading