feat: output types & list items are now nullable by default #508
Conversation
BREAKING CHANGE: - output types are now nullable by default. Type! -> Type - list items are now nullable by default. [Type!] -> [Type]
| @@ -1147,7 +1147,7 @@ export class SchemaBuilder { | |||
| protected decorateList<T extends GraphQLOutputType | GraphQLInputType>(type: T, list: true | boolean[]): T { | |||
| let finalType = type | |||
| if (!Array.isArray(list)) { | |||
| return GraphQLList(GraphQLNonNull(type)) as T | |||
There was a problem hiding this comment.
bug fix for making list items non-nullable by default
| @@ -420,7 +420,7 @@ export class SchemaBuilder { | |||
| constructor(protected config: BuilderConfig) { | |||
| this.nonNullDefaults = { | |||
| input: false, | |||
| output: true, | |||
| output: false, | |||
There was a problem hiding this comment.
makes output types nullable by default
Weakky
changed the title
| resolve: () => [1, 2, null], | ||
| }), | ||
| queryField('userList', { | ||
| type: 'User', | ||
| list: true, | ||
| list: [true], |
There was a problem hiding this comment.
The array syntax for list has always felt kind of awkward. Was thinking we could deprecate the list property on the object here, instead adding list and nonNull helper fns similar to graphene https://docs.graphene-python.org/en/latest/types/list-and-nonnull/, so this would become:
import { list, queryField } from '@nexus/schema'
queryField('userList', {
type: list('User'),
resolve: () => [null, Promise.resolve(null), null],
})Haven't taken a shot at it yet, but I don't think it'd be too difficult to type / unwrap as necessary.
There was a problem hiding this comment.
Could we defer this change to another issue/PR. Agree that we have room to improve here. But I don't think this is necessary to tackle here or in order to ship nullability defaults change.
@tgriesser OK with you?
There was a problem hiding this comment.
The array syntax for
listhas always felt kind of awkward. Was thinking we could deprecate thelistproperty on the object here, instead addinglistandnonNullhelper fns similar to graphene https://docs.graphene-python.org/en/latest/types/list-and-nonnull/, so this would become:import { list, queryField } from '@nexus/schema' queryField('userList', { type: list('User'), resolve: () => [null, Promise.resolve(null), null], })Haven't taken a shot at it yet, but I don't think it'd be too difficult to type / unwrap as necessary.
Why to drop it? Is it hard to keep those two options?
There was a problem hiding this comment.
@homoky we can keep it around for a bit (or forever) I suppose - just like the idea of consolidating on one way to do things when it's practical.
Fixes #588 by ensuring that list items follow `nonNullDefaults`, which was lost in the #508 refactor Fixes #384 by removing explicit nullability config from the connection `edges` definition, and also allowing `nonNullDefaults` to be supplied for the connection "types" generated by the creation of a connection field. Allows you to configure both globally in the connection plugin field config, and when the connection field is defined.
This PR