Interface Gql2TsOptions

interface Gql2TsOptions {
    argv?: string[];
    client?: boolean;
    introspection?: IntrospectionOptions;
    introspector?: GraphQLIntrospector;
    logger?: LoggerLike;
    noExit?: boolean;
    operations?: string;
    out?: string;
    reader?: GraphQLReader;
    root?: string;
    scalarTypes?: Record<string, string | {
        from?: string;
        type: string;
    }>;
    schema?: string;
    server?: boolean;
    stitching?: boolean;
    watch?: boolean;
}

Hierarchy (view full)

Properties

argv? client? introspection? introspector? logger? noExit? operations? out? reader? root? scalarTypes? schema? server? stitching? watch?

Properties

Optionalargv

argv?: string[]

Set command-line arguments. Defaults to process.argv.

Optionalclient

client?: boolean

Should client types be generated? Defaults to false.

Optionalintrospection

introspection?: IntrospectionOptions

Introspection options (only required for client-code generation)

Optionalintrospector

introspector?: GraphQLIntrospector

Optionallogger

logger?: LoggerLike

The logger used in the CLI. Defaults to console.

OptionalnoExit

noExit?: boolean

If true, does not exit the process on error.

Optionaloperations

operations?: string

Path to directory of GraphQL operation documents, relative to root. Defaults to "operations".

Optionalout

out?: string

Path to directory to place generated code, relative to root. Defaults to "src/generated".

Optionalreader

reader?: GraphQLReader

Optionalroot

root?: string

Path to root directory for code generation. It's recommended to use a root relative to __dirname. Defaults to the current working dir.

OptionalscalarTypes

scalarTypes?: Record<string, string | {
    from?: string;
    type: string;
}>

Optionalschema

schema?: string

Path to directory of GraphQL schema documents, relative to root. Defaults to "schema".

Optionalserver

server?: boolean

Should server types be generated? Defaults to false.

Optionalstitching

stitching?: boolean

Optionalwatch

watch?: boolean

Should the CLI run in watch mode? Defaults to false.

Settings

Member Visibility

On This Page

Properties