An "or" in object properties types

[dougg0k]

Hi,

I've been migrating an API to pothos and I wanted to know if there is a or implementation in case you want a object property type to be one type or another? e.g., type | string | stringList.

I'm mostly using simpleObject plugin for it, but I also didnt see anything in the actual objects docs.

If not, could you add / implement?

Thanks

[hayes]

GraphQL doesn't have a way to represent that. You mentioned migrating, what does the existing graphql schema look like?

At the typescript level you can do something like:

builder.objectRef<{ prop: string | string[] }>('Type'). implement({
  fields: (t) => ({
    prop: t.stringList({
      resolve: (parent) => Array.isArray(parent.prop) ? parent.prop : [parent.prop]
  })
})

Your typescript types can be anything you want, but the GraphQL types are limited by what's possible in GraphQL

If your typescript and graphql types are different, you need resolvers to map between them, like in this example we take the string or array of strings and always make it an array on the graphql side.

[dougg0k]

I understand. I wanted to know about the graphql types.

Look like in what? Nothing much, it's a few years old project that I am doing a full migration and upgrade with a recent and better implementation all around.

Thanks.

[hayes]

Yup, graphql doesn't have anything like that. Closest thing would be unions, but all union members need to be be object types. You could have a union of different objects that have 1 property.

For inputs they added the @OneOf directive which indicates only one field will be set, and there was some talk of trying to add that for output objects too, but I don't think that's made much progress