Interface SourceTypeModule

src/typegenAutoConfig.ts:17–47

}

export interface SourceTypeModule {
  /**
   * The module for where to look for the types. This uses the node resolution algorithm via require.resolve,
   * so if this lives in node_modules, you can just provide the module name otherwise you should provide the
   * absolute path to the file.
   */
  module: string
  /**
   * When we import the module, we use `import * as ____` to prevent conflicts. This alias should be a name
   * that doesn't conflict with any other types, usually a short lowercase name.
   */
  alias: string
  /**
   * Provides a custom approach to matching for the type
   *
   * If not provided, the default implementation is:
   *
   * (type) => [ new RegExp(`(?:interface|type|class|enum)\\s+(${type.name})\\W`, "g"), ]
   */
  typeMatch?: (type: GraphQLNamedType, defaultRegex: RegExp) => RegExp | RegExp[]
  /**
   * A list of typesNames or regular expressions matching type names that should be resolved by this import.
   * Provide an empty array if you wish to use the file for context and ensure no other types are matched.
   */
  onlyTypes?: (string | RegExp)[]
  /**
   * By default the import is configured `import * as alias from`, setting glob to false will change this to
   * `import alias from`
   */
  glob?: false
}

export interface SourceTypesConfigOptions {
  /** Any headers to prefix on the generated type file */