@vnodes/graphql
    Preparing search index...

    Interface DefinitionsGeneratorOptions

    interface DefinitionsGeneratorOptions {
        additionalHeader?: string;
        customScalarTypeMapping?: Record<string, string | { name: string }>;
        defaultScalarType?: string;
        defaultTypeMapping?: Partial<
            Record<"ID" | "Float" | "Int", "string" | "number"> & Record<
                "Boolean"
                | "String",
                "string" | "number" | "boolean",
            >,
        >;
        emitTypenameField?: boolean;
        enumsAsTypes?: boolean;
        skipResolverArgs?: boolean;
        typeName?: (name: string) => string;
    }
    Index

    Properties

    additionalHeader? customScalarTypeMapping? defaultScalarType? defaultTypeMapping? emitTypenameField? enumsAsTypes? skipResolverArgs? typeName?

    Properties

    additionalHeader?: string

    If provided, specifies a custom header to add after the to the output file (eg. for custom type imports or comments)

    undefined
    customScalarTypeMapping?: Record<string, string | { name: string }>

    If provided, specifies a mapping of types to use for custom scalars

    undefined
    defaultScalarType?: string

    If provided, specifies a default generated TypeScript type for custom scalars.

    'any'
    defaultTypeMapping?: Partial<
        Record<"ID" | "Float" | "Int", "string" | "number"> & Record<
            "Boolean"
            | "String",
            "string" | "number" | "boolean",
        >,
    >

    If provided, specifies a mapping of default scalar types (Int, Boolean, ID, Float, String).

    undefined
    emitTypenameField?: boolean

    If true, the additional "__typename" field is generated for every object type.

    false
    enumsAsTypes?: boolean

    If true, enums are generated as string literal union types.

    false
    skipResolverArgs?: boolean

    If true, resolvers (query/mutation/etc) are generated as plain fields without arguments.

    false
    typeName?: (name: string) => string

    If provided, specifies a function to transform type names.

    (name) => `${name}Schema`

    undefined

    Settings

    Member Visibility

    On This Page

    Properties