zap-cdk
    Preparing search index...

    Interface IGraphQL

    IGraphQL Represents the configuration for a GraphQL operation.

    interface IGraphQL {
        argsType?: ArgsType;
        endpoint?: string;
        lenientMaxQueryDepthEnabled?: boolean;
        maxAdditionalQueryDepth?: number;
        maxArgsDepth?: number;
        maxQueryDepth?: number;
        optionalArgsEnabled?: boolean;
        queryGenEnabled?: boolean;
        querySplitType?: QuerySplitType;
        requestMethod?: RequestMethod;
        schemaFile?: string;
        schemaUrl?: string;
    }
    Index

    Properties

    argsType? endpoint? lenientMaxQueryDepthEnabled? maxAdditionalQueryDepth? maxArgsDepth? maxQueryDepth? optionalArgsEnabled? queryGenEnabled? querySplitType? requestMethod? schemaFile? schemaUrl?

    Properties

    argsType?: ArgsType

    How arguments are specified, default: both.

    endpoint?: string

    The endpoint URL, default: null.

    lenientMaxQueryDepthEnabled?: boolean

    Whether Maximum Query Depth is enforced leniently, default: true.

    maxAdditionalQueryDepth?: number

    The maximum additional query generation depth, default: 5.

    maxArgsDepth?: number

    The maximum arguments generation depth, default: 5.

    maxQueryDepth?: number

    The maximum query generation depth, default: 5.

    optionalArgsEnabled?: boolean

    Whether Optional Arguments should be specified, default: true.

    queryGenEnabled?: boolean

    Whether the Query Generator is enabled, default: true.

    querySplitType?: QuerySplitType

    The level for which a single query is generated, default: leaf.

    requestMethod?: RequestMethod

    The request method, default: post_json.

    schemaFile?: string

    Local file path of a GraphQL Schema, default: null.

    schemaUrl?: string

    URL pointing to a GraphQL Schema, default: null.

    Settings

    Member Visibility

    On This Page

    Properties