Interface BaseGraphQLSitemapServiceConfig

Configuration options for

See

GraphQLSitemapService instances

interface BaseGraphQLSitemapServiceConfig {
    apiKey: string;
    endpoint: string;
    excludedPaths?: string[];
    includePersonalizedRoutes?: boolean;
    includedPaths?: string[];
    pageSize?: number;
}

Hierarchy

Properties

apiKey endpoint excludedPaths? includePersonalizedRoutes? includedPaths? pageSize?

Properties

apiKey

apiKey: string

The API key to use for authentication.

endpoint

endpoint: string

Your Graphql endpoint

Optional excludedPaths

excludedPaths?: string[]

Optional. Paths starting with these provided prefixes will be excluded from returned results.

Optional includePersonalizedRoutes

includePersonalizedRoutes?: boolean

A flag for whether to include personalized routes in service output - only works on XM Cloud turned off by default

Optional includedPaths

includedPaths?: string[]

Optional. Only paths starting with these provided prefixes will be returned.

Optional pageSize

pageSize?: number

common variable for all GraphQL queries it will be used for every type of query to regulate result batch size Optional. How many result items to fetch in each GraphQL call. This is needed for pagination.

Default

100

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc