Logo for jsDocs.io

graphql-code-generator

  • Version 0.18.2
  • Published
  • 143 kB
  • 33 dependencies
  • MIT license

Install

npm i graphql-code-generator
yarn add graphql-code-generator
pnpm add graphql-code-generator

Overview

<p align="center"> <img src="https://github.com/dotansimha/graphql-code-generator/blob/master/logo.png?raw=true" /> </p>

Index

Functions

Interfaces

Namespaces

Functions

function createConfigFromOldCli

createConfigFromOldCli: (options: CLIOptions) => Types.Config;

    function executeCodegen

    executeCodegen: (config: Types.Config) => Promise<FileOutput[]>;

      function generate

      generate: (
          config: Types.Config,
          saveToFile?: boolean
      ) => Promise<FileOutput[] | any>;

        Interfaces

        interface CLIOptions

        interface CLIOptions {}

          property args

          args?: string[];

            property clientSchema

            clientSchema?: string;

              property config

              config?: string;

                property exitOnError

                exitOnError?: boolean;

                  property header

                  header?: string[];

                    property mergeSchema

                    mergeSchema?: string;

                      property out

                      out?: string;

                        property overwrite

                        overwrite?: boolean;

                          property project

                          project?: string;

                            property require

                            require?: string[];

                              property schema

                              schema?: string;

                                property silent

                                silent?: boolean;

                                  property skipDocuments

                                  skipDocuments?: any;

                                    property skipSchema

                                    skipSchema?: any;

                                      property template

                                      template?: string;

                                        property templateConfig

                                        templateConfig?: {
                                            [key: string]: any;
                                        };

                                          property watch

                                          watch?: boolean;

                                            Namespaces

                                            namespace indent-string

                                            module 'indent-string' {}

                                              namespace is-valid-path

                                              module 'is-valid-path' {}

                                                function isValidPath

                                                isValidPath: (path: string) => boolean;

                                                  namespace json-to-pretty-yaml

                                                  module 'json-to-pretty-yaml' {}

                                                    namespace listr-update-renderer

                                                    module 'listr-update-renderer' {}

                                                      Package Files (5)

                                                      Dependencies (33)

                                                      Dev Dependencies (13)

                                                      Peer Dependencies (1)

                                                      Badge

                                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/graphql-code-generator.

                                                      • Markdown
                                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/graphql-code-generator)
                                                      • HTML
                                                        <a href="https://www.jsdocs.io/package/graphql-code-generator"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>