How to get params type？

[dohooo]

like title...

[acro5piano]

Hi @zwh1666258377, thank you for your interest in this project!

Do you mean operation params by params right?
If so, currently there are no ways to define and get type of params.

const params = { $input: 'UserInput!' }

// `typeof params` is just { $input: string }

Unlike typed-graphqlify, Apollo Codegen creates input type, so adding the feature seems good.

We possibly create params builder like this:

import { graphqlify, ParamsBuilder, types } from 'typed-graphqlify'

const builder = new ParamsBuilder('$input', 'UserInput!', {
  name: types.string,
})
builder.toString() // => { $input: 'UserInput!' }
typeof builder.type // => { name: string }

// now, type-check is enabled
graphqlify.mutation('UpdateUser', params(builder), {
  updateUser: builder.render({ name: 'Tom' }, {
    name: types.string
  })
})

// This must throw type error
builder.render({ name: 123 }, { ... })

And the interface will look this:

class ParamsBuilder<T> {
  constructor<T> (paramName: string, typeName: string, type: T)
  toString(): string
  render(params: T): T
}

Also note #51 might affect it.

Thanks

[acro5piano]

Or, simply

import { graphqlify, types } from 'typed-graphqlify'

interface UpdateUserParams {
  name: string
}

graphqlify.mutation<UpdateUserParams>('UpdateUser', params({ name: 'Tom' }, {
  updateUser: {
    name: types.string,
  },
})

[acro5piano]

However, people query variables like

fetch('/graphql', {
  body: JSON.stringify({
    query: ...,
    variables: {
      name: 'Tom',
    },
  }),
})

[dohooo]

👍

[laurensdijkstra]

Or, simply

import { graphqlify, types } from 'typed-graphqlify'

interface UpdateUserParams {
  name: string
}

graphqlify.mutation<UpdateUserParams>('UpdateUser', params({ name: 'Tom' }, {
  updateUser: {
    name: types.string,
  },
})

This is what I'm trying to do with typed-graphqlify right now, however in the output after conversion to string, the quotation marks around 'Tom' are gone, making the GraphQL syntax illegal. Any way to circumvent/fix this?

[acro5piano]

@laurensdijkstra

This issue might help you. Which version do you use?

#46

[acro5piano]

Got it.

https://github.com/acro5piano/typed-graphqlify/blob/master/src/__test__/index.test.ts#L254

Currently we expect query-level vars, so in your case you have to use rawString helper.
I would like to make an improvement that automatically remove " only if car value starts with $.

Thanks!

[laurensdijkstra]

Currently we expect query-level vars, so in your case you have to use rawString helper.

I created a helper function that recursively runs JSON.stringify() on all string values of the parameters object, whichs works nicely. Thanks!