Graphql Codegen - Enum with custom key => value

Question

I use graphql-codegen to generate type files.

As an example, let's say I have the following in my schema.graphql file:

enum cities {
 JOHANNESBURG
 CAIRO
 NEW_YORK
 LONDON
 BEIJING
}

The output in my generated-types.ts file is as follows:

export enum cities {
 Johannesburg = 'JOHANNESBURG'
 Cairo = 'CAIRO'
 NewYork = 'NEW_YORK'
 London = 'LONDON'
 Beijing = 'BEIJING'
}

Is there a way for me to 'override' the value of the enum before codegen runs? Perhaps something as follows (which I obviously tried):

enum cities {
 JOHANNESBURG: 'JNB'
 CAIRO: 'CAI'
 NEW_YORK: 'NYC'
 LONDON: 'LON'
 BEIJING: 'BEI'
}

which in turn should produce:

export enum cities {
 Johannesburg = 'JNB'
 Cairo = 'CAI'
 NewYork = 'NYC'
 London = 'LON'
 Beijing = 'BEI'
}

Ewe Tek Min · Accepted Answer · 2021-03-21 03:47:43Z

8

not sure if I'm too late, but you probably can use the enumValues to customize your internal enum values. Here is the documentation. For example:

./types.ts

export enum cities {
 Johannesburg = 'JNB'
 Cairo = 'CAI'
 NewYork = 'NYC'
 London = 'LON'
 Beijing = 'BEI'
}

./codegen.yml

generates:
  src/graphql.types.ts:
    config:
      useIndexSignature: true
      enumValues:
        cities: ./types#cities // path to your custom types
    plugins:
      - typescript
      - typescript-resolvers

answered Mar 21, 2021 at 3:47

Ewe Tek Min

87511 silver badges21 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Andrew Ross Over a year ago

Thank you! This answer was exactly what I needed after migrating my graphql endpoint from headless wordpress to onegraph. The former uses actual string names for enum values whereas the latter uses numeric enums. Apollo was not loving numeric enums, even started a thread on here about it stackoverflow.com/questions/66929685/…

bombillazo Over a year ago

Why can't codegen derive the values from the specified values set in GraphQL? Manually creating and mapping values defeats the purpose of autogenerating those same values you need.

Collectives™ on Stack Overflow

Graphql Codegen - Enum with custom key => value

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related