Improve the documentation

[innovaweb-dev]

The topic about the Interface is not clear for me.
Can someone to give me explain and a exemple to create and use a Interface with graphql-compose.

https://graphql-compose.github.io/docs/basics/understanding-types.html#interfaces-via-interfacetypecomposer
For exemple, I don't understand this parts value => (value instanceof UserDoc) and where from UserDoc ?

Update message

After some hours on graphql-compose, I see that some functions are not enough documented with a complete example.
Like InterfaceTypeComposer previously, I can't understand also how to use a inputType after created it with InputTypeComposer.

For the beginer like me, the documentation is well done at the begining, to create schema, query and mutation, that clear.
But when I go to advenced concept like Interface, Input and Union, the explains and examples are not sufficient.

Same things with "ThunkComposer" and "Extensions Methods", what is ?

Update message

What are the "Field Args methods" used for?
graphql-compose can manage introspection ?

Thanks,

[nodkz]

Sorry for the late response. I don't have enough free time to polish all things.

graphql-compose can manage introspection ?

Yes and no. Before calling schemaComposer.buildSchema() you may change your types as you wish even removing any field. For example, via graphql-compose-mongoose generator you may create graphql types & resolvers from mongoose schema; and before schema construction, you may remove/add/modify any field.

Same things with "ThunkComposer" and "Extensions Methods", what is ?

ThunkComposer - it's an internal wrapper that helps to solve hoisting problems when several javascript modules imports each other. ThunkComposer used internally and unwraps only when you call schemaComposer.buildSchema().

Extensions Methods – methods that allow manipulation of some additional data (configuration options, callback etc like Directives) in GraphQL types. In graphql-js it was added in graphql/graphql-js#2097. And discussed in graphql/graphql-js#1527 and graphql/graphql-js#1343

Can someone to give me explain and a exemple to create and use a Interface with graphql-compose.

Before returning data from resolver graphql want to determine which exact Type should be used for returning data.
You may take a look at this test case

graphql-compose/src/__tests__/InterfaceTypeComposer-test.ts

Line 1125 in 58a5d46

it('integration test', async () => {

[innovaweb-dev]

Thanks, success for your work.
Great package, but I hope that documentation will be improve someday. 👍