graphqlade
    Preparing search index...

    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 Summary)

    Index

    Properties

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

    Properties

    argv?: string[]

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

    client?: boolean

    Should client types be generated? Defaults to false.

    introspection?: IntrospectionOptions

    Introspection options (only required for client-code generation)

    introspector?: GraphQLIntrospector
    logger?: LoggerLike

    The logger used in the CLI. Defaults to console.

    noExit?: boolean

    If true, does not exit the process on error.

    operations?: string

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

    out?: string

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

    reader?: GraphQLReader
    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.

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

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

    server?: boolean

    Should server types be generated? Defaults to false.

    stitching?: boolean
    watch?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties