Skip to main content

StellatePluginOptions

StellatePluginOptions​

@vendure/stellate-plugintypes.ts

Configuration options for the StellatePlugin.

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

serviceName​

property
string

The Stellate service name, i.e. <service-name>.stellate.sh

apiToken​

property
string

The Stellate Purging API token. For instructions on how to generate the token, see the Stellate docs

purgeRules​

property
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​

property
number
default:
2000

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​

property
boolean
default:
false

When set to true, calls will not be made to the Stellate Purge API.

debugLogging​

property
boolean
default:
false

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.