Documentation on specific options for avoidOptionals

[henrywoody]

I've been looking into the docs on the avoidOptionals config option and have found it difficult to understand the exact meaning of each of the sub-options when providing a AvoidOptionalsConfig object (defined here) as the value.

Here's how I understand the options:

• field: Field of a type (using the GraphQL type declaration).
• inputValue: Fields on a GraphQL input type. Though I did have to double check that this did not refer to variable inputs for queries/mutations.
• object: No idea.
• defaultValue: I think this would be when setting a default value for a query/mutation. Not sure, but also I haven't used a default value on a query/mutation in my codebase.
• resolvers: (Not listed in docs) I think referring to client-side resolvers. Really not sure, but haven't used those in my codebase either.

Can someone who knows add docs about what each of these fields do? Thank you!

[charlypoly]

Hi @henrywoody,

You are right, there is some documentation missing on some specific sub-options of avoidOptionals.

Here is some information on the undocumented parts:

• object: applies to object type in a conditional context (ex: when using @skip that results in an optional union of objects)
• defaultValue: subset of inputValue option, applies to input object arguments (to add or not ? to argument with default value)
• resolvers: applies to the fields of the Resolvers type generated by typescript-resolvers

Let me know if you need further information!

[pvinis]

it would be better to have more descriptive names for these.

[saihaj]

it would be better to have more descriptive names for these.

@pvinis what do you recommend?

[pvinis]

like fieldsWithDefaultValue, regularFields, mutationInputs, conditionalObjects, etc