Skip to content

Latest commit

 

History

History
319 lines (205 loc) · 6.2 KB

c-sharp-operations.md

File metadata and controls

319 lines (205 loc) · 6.2 KB
Raw

This plugin generates C# class based on your GraphQL operations.

Installation

:::shell Using yarn

$ yarn add -D @graphql-codegen/c-sharp-operations

:::

API Reference

namespaceName

type: string default: GraphQLCodeGen

Allow you to customize the namespace name.

Usage Examples

config:
  namespaceName: MyCompany.MyNamespace

namedClient

type: string

Defined the global value of namedClient.

Usage Examples

config:
  namedClient: 'customName'

querySuffix

type: string default: GQL

Allows to define a custom suffix for query operations.

Usage Examples

config:
  querySuffix: 'QueryService'

mutationSuffix

type: string default: GQL

Allows to define a custom suffix for mutation operations.

Usage Examples

config:
  mutationSuffix: 'MutationService'

subscriptionSuffix

type: string default: GQL

Allows to define a custom suffix for Subscription operations.

Usage Examples

config:
  subscriptionSuffix: 'SubscriptionService'

noGraphQLTag

type: boolean default: false

Deprecated. Changes the documentMode to documentNode.

gqlImport

type: string default: gql#graphql-tag

Customize from which module will gql be imported from. This is useful if you want to use modules other than graphql-tag, e.g. graphql.macro.

Usage Examples

graphql.macro
config:
  gqlImport: graphql.macro#gql
Gatsby
config:
  gqlImport: gatsby#graphql

noExport

type: boolean default: false

Set this configuration to true if you wish to tell codegen to generate code with no export identifier.

dedupeOperationSuffix

type: boolean default: false

Set this configuration to true if you wish to make sure to remove duplicate operation name suffix.

omitOperationSuffix

type: boolean default: false

Set this configuration to true if you wish to disable auto add suffix of operation name, like Query, Mutation, Subscription, Fragment.

operationResultSuffix

type: string default: ``

Adds a suffix to generated operation result type names

documentVariablePrefix

type: string default: ``

Changes the GraphQL operations variables prefix.

documentVariableSuffix

type: string default: Document

Changes the GraphQL operations variables suffix.

fragmentVariablePrefix

type: string default: ``

Changes the GraphQL fragments variables prefix.

fragmentVariableSuffix

type: string default: FragmentDoc

Changes the GraphQL fragments variables suffix.

documentMode

type: DocumentMode default: graphQLTag

Declares how DocumentNode are created:

  • graphQLTag: graphql-tag or other modules (check gqlImport) will be used to generate document nodes. If this is used, document nodes are generated on client side i.e. the module used to generate this will be shipped to the client
  • documentNode: document nodes will be generated as objects when we generate the templates.
  • documentNodeImportFragments: Similar to documentNode except it imports external fragments instead of embedding them.
  • external: document nodes are imported from an external file. To be used with importDocumentNodeExternallyFrom

importOperationTypesFrom

type: string default: ``

This config is used internally by presets, but you can use it manually to tell codegen to prefix all base types that it's using. This is useful if you wish to generate base types from typescript-operations plugin into a different file, and import it from there.

importDocumentNodeExternallyFrom

type: string default: ``

This config should be used if documentMode is external. This has 2 usage:

  • any string: This would be the path to import document nodes from. This can be used if we want to manually create the document nodes e.g. Use graphql-tag in a separate file and export the generated document
  • 'near-operation-file': This is a special mode that is intended to be used with near-operation-file preset to import document nodes from those files. If these files are .graphql files, we make use of webpack loader.

Usage Examples

config:
  documentMode: external
  importDocumentNodeExternallyFrom: path/to/document-node-file
config:
  documentMode: external
  importDocumentNodeExternallyFrom: near-operation-file

scalars

type: ScalarsMap

Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type.

Usage Examples

config:
  scalars:
    DateTime: Date
    JSON: "{ [key: string]: any }"

namingConvention

type: NamingConvention default: pascal-case#pascalCase

Allow you to override the naming convention of the output. You can either override all namings, or specify an object with specific custom naming convention per output. The format of the converter must be a valid module#method. Allowed values for specific output are: typeNames, enumValues. You can also use "keep" to keep all GraphQL names as-is. Additionally you can set transformUnderscore to true if you want to override the default behavior, which is to preserves underscores.

Usage Examples

Override All Names
config:
  namingConvention: lower-case#lowerCase
Upper-case enum values
config:
  namingConvention:
    typeNames: pascal-case#pascalCase
    enumValues: upper-case#upperCase
Keep names as is
config:
  namingConvention: keep
Remove Underscores
config:
  namingConvention:
    typeNames: pascal-case#pascalCase
    transformUnderscore: true

typesPrefix

type: string default: ``

Prefixes all the generated types.

Usage Examples

config:
  typesPrefix: I

skipTypename

type: boolean default: false

Does not add __typename to the generated types, unless it was specified in the selection set.

Usage Examples

config:
  skipTypename: true

nonOptionalTypename

type: boolean default: false

Automatically adds __typename field to the generated types, even when they are not specified in the selection set, and makes it non-optional

Usage Examples

config:
  nonOptionalTypename: true