vendure/docs/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.md

---

title: "StellatePluginOptions" isDefaultIndex: false

generated: true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

StellatePluginOptions

Configuration options for the StellatePlugin.

interface StellatePluginOptions {
    serviceName: string;
    apiToken: string;
    purgeRules: PurgeRule[];
    defaultBufferTimeMs?: number;
    devMode?: boolean;
    debugLogging?: boolean;
}

### serviceName The Stellate service name, i.e. `.stellate.sh` ### apiToken The Stellate Purging API token. For instructions on how to generate the token, see the [Stellate docs](https://docs.stellate.co/docs/purging-api#authentication) ### purgeRules PurgeRule[]`} /> An array of PurgeRule instances which are used to define how the plugin will respond to Vendure events in order to trigger calls to the Stellate Purging API. ### defaultBufferTimeMs When events are published, the PurgeRules will buffer those events in order to efficiently batch requests to the Stellate Purging API. You may wish to change the default, e.g. if you are running in a serverless environment and cannot introduce pauses after the main request has completed. ### devMode When set to `true`, calls will not be made to the Stellate Purge API. ### debugLogging If set to true, the plugin will log the calls that would be made to the Stellate Purge API. Note, this generates a lot of debug-level logging.