Global Context type

[bombillazo]

Hello, I am trying to follow these instructions on typing the Context but don't know where I need to declare that Global namespace.

[ardatan]

You can define it anywhere. It should work

[bombillazo]

Thanks for answering. I am new to using namespaces, I added that expression to my common module but I still see the context type as any .

I am using GraphQL Express server and want to add the Express Req to my Context.

[bombillazo]

@ardatan Would you happen to have an example in a repo?

[bombillazo]

Don't know what else is required so my context gets Globally typed.

[bombillazo]

Ok got it to work the following manner:

1. Add the declare statement in your code (as specified above). I have mine in the index.ts file where I create my graphql-modules application.

declare global {
  namespace GraphQLModules {
    interface GlobalContext {
      myProp: string; 
    }
  }
}  

const application = createApplication({
...

2. Use GraphQL Code Generator typescript-resolvers plugin to add the context type to my resolvers. I am doing it programmatically but it's the same concept:

generates:
path/to/file.ts:
  plugins: 
    - typescript
    - typescript-resolvers
  config:
    contextType: "GraphQLModules.Context"
...

After that my resolver context gets typed! :D

[bombillazo]

Hey @Urigo , I think what confused me was understanding that modifying the GraphQLModules.GlobalContext using namespace automatically would reflect the type in the context input. I still needed to set the type manually in my resolvers, or (how I did it) use Code Generator to set my Context type for all resolvers.

I'm a beginner at TypeScript and GraphQL so it wasn't clear to me. Explicitly mentioning that you still need to set the type somewhere would've made it clearer for me. I thought Modules did that for me.

[Urigo]

Thanks for sharing @bombillazo !

Do you think you are able to create a draft pull request with the wording that would be best for you?
https://github.com/Urigo/graphql-modules/edit/master/website/docs/essentials/type-safety.md

I believe you would be best to structure it as you are the one who was in this position just now.

I would love to help of course

[bombillazo]

Hey @Urigo , a PR I mas was merged, but I dont see the docs have been updated

[Urigo]

it should be updated now

[enheit]

@Urigo Hey, I just read your tread and want to say that I also had an issue with context type. Would be nice if you explicitly show where to put this definition.

Firstly, I tried to put this code inside graphql-context.d.ts file and add it to the typeRoots of tsconfig.json file of my project. It didn't help

After investigating @bombillazo code I decided to put it beside createApplication({ ... }) call. It works, but show warnings

ES2015 module syntax is preferred over custom TypeScript modules and namespaces. (@typescript-eslint/no-namespace)ts-standard(@typescript-eslint/no-namespace)

So, would be nice to have a little more information on that in your documentation