How to set directives for fields when creating GraphQLObjectType?

[nodkz]

Can somebody share proper way how to pass directives for fields when creating type via GraphQLObjectType? I want to integrate graphql-cost-analysis to our GraphQL Schema.

A astNode: FieldDefinitionNode in GraphQLFieldConfig is ReadOnly and there is now way to write directives via object config. Or i something missing?

Desired way to declare directive will be such:

const UserType = new GraphQLObjectType({
  name: 'User',
  fields: {
    name: {
      type: GraphQLString,
      description: '...',
      resolve: () => ...,
      directives: [
        { name: 'cost',  args: { useMultipliers: false, complexity: 2 } },
        { name: 'unique' },
      ],
      // or maybe simpler if graphql spec does not allow duplicated names
      directives: {
        cost: { useMultipliers: false, complexity: 2 },
        unique: true,
      },
    },
  },
});

cc @IvanGoncharov @leebyron

[IvanGoncharov]

@nodkz It was already discussed in my PR that added astNode feature and @leebyron had the following position: #746 (comment)

Right now directives are purely a feature of the GraphQL language and IDL, so a schema not created using IDL definitionally won't contain directives. When building a schema in code, you have the full power of the host programming environment, so directives shouldn't be necessary. Directives are a tool for supplying additional intent to be later interpreted by the host programming environment.

Also, I think this question is connected to the topic discussed on the last WG: Exposing schema metadata. So I think we should decide what we expose through introspection(directives or something else) and then add the same thing to GraphQL*Type classes.

[leebyron]

Yeah - I stand by that comment.

You can include any arbitrary data on a GraphQLObjectType that you like - it's just a JS object after all. Directives are a language-level feature, not a structural property of a type.

Typically tools which use directives in the SDL are adding properties to the created underlying type objects to track within their runtimes.