@graphql-codegen/import-types-preset/typings/index.d.ts

GraphQL Code Generator preset for importing types to operation file

import { FragmentDefinitionNode } from 'graphql';
import { Types } from '@graphql-codegen/plugin-helpers';
export type ImportTypesConfig = {
    /**
     * @description Required, should point to the base schema types file.
     * The key of the output is used a the base path for this file.
     *
     * @exampleMarkdown
     * ```ts filename="codegen.ts" {10}
     *  import type { CodegenConfig } from '@graphql-codegen/cli';
     *
     *  const config: CodegenConfig = {
     *    // ...
     *    generates: {
     *      'path/to/file.ts': {
     *        preset: 'import-types',
     *        plugins: ['typescript-operations'],
     *        presetConfig: {
     *          typesPath: 'types.ts'
     *        },
     *      },
     *    },
     *  };
     *  export default config;
     * ```
     */
    typesPath: string;
    /**
     * @description Optional, override the name of the import namespace used to import from the `baseTypesPath` file.
     * @default Types
     *
     * @exampleMarkdown
     * ```ts filename="codegen.ts" {11}
     *  import type { CodegenConfig } from '@graphql-codegen/cli';
     *
     *  const config: CodegenConfig = {
     *    // ...
     *    generates: {
     *      'path/to/file.ts': {
     *        preset: 'import-types',
     *        plugins: ['typescript-operations'],
     *        presetConfig: {
     *          typesPath: 'types.ts',
     *          importTypesNamespace: 'SchemaTypes',
     *        },
     *      },
     *    },
     *  };
     *  export default config;
     * ```
     */
    importTypesNamespace?: string;
};
export type FragmentNameToFile = {
    [fragmentName: string]: {
        location: string;
        importName: string;
        onType: string;
        node: FragmentDefinitionNode;
    };
};
export declare const preset: Types.OutputPreset<ImportTypesConfig>;
export default preset;