Graphql ListOptions are automatically added to queries that return Lists.

[skid]

Hi. I noticed that Vendure silently overrides (and/or adds?) any Graphql query parameters called "options" with its own types if the return type is an List.

For example, I'm writing a method for searching products and the graphql definition is as follows:

searchProducts(query: String, facetIds: [ID!], matchAll: Boolean, options: MyOwnListOptions): ProductList

But the generated code contains this

searchProducts(query: String, facetIds: [ID!], matchAll: Boolean, options: ProductListOptions): ProductList

Is this by design? Can it be turned off?

[skid]

Kevin Mattutat:

I think this is intended and triggered by the return type that implements PaginatedList .
I see two option to fix this quickly:
You can add your own properties to the generated ProductListOptions type
You can return another type so that the generation is not triggered (but it should not implement PaginatedList)
Personally I like the way it's implemented. So I just always go with the naming. But I get that it might be frustating in your case. (edited)

Michael Bromley:
Yes Kevin is right - this is a convenience feature that allows you to create list queries with full sort/filter support without having to implement it all yourself. The heuristic used is that:
The return type is named List, where is a valid object type in the schema.
The return type implements the PaginatedList interface.