70:I[539692,["/_next/static/chunks/2681zlkv3lyop.js","/_next/static/chunks/2_bnfr80cctuw.js","/_next/static/chunks/2kbo5axhrz1os.js","/_next/static/chunks/1xhl5-05_8ema.js","/_next/static/chunks/3dl6z98y327wm.js","/_next/static/chunks/0tg6tkaco7r13.js","/_next/static/chunks/2dh4fs0b-59w7.js","/_next/static/chunks/2enq7j8ezvdf_.js","/_next/static/chunks/3enx74ouifseg.js","/_next/static/chunks/02m7uqem7_cm0.js","/_next/static/chunks/3xnqwtcs0m086.js","/_next/static/chunks/0njbwr6_u5vrf.js","/_next/static/chunks/078md0ja99fxe.js","/_next/static/chunks/2m7zx1h3ogrnv.js","/_next/static/chunks/3cgdinzv7h_c_.js","/_next/static/chunks/1ad7onw0ko-du.js","/_next/static/chunks/3w6u7-_luoiy7.js","/_next/static/chunks/3fibmfnwxxxpf.js","/_next/static/chunks/17n4z8lw1pwyr.js","/_next/static/chunks/2u-wrzchr0mp9.js","/_next/static/chunks/0a39rll0uaun7.js"],"MobileToc"] 71:I[435451,["/_next/static/chunks/2681zlkv3lyop.js","/_next/static/chunks/2_bnfr80cctuw.js","/_next/static/chunks/2kbo5axhrz1os.js","/_next/static/chunks/1xhl5-05_8ema.js","/_next/static/chunks/3dl6z98y327wm.js","/_next/static/chunks/0tg6tkaco7r13.js","/_next/static/chunks/2dh4fs0b-59w7.js","/_next/static/chunks/2enq7j8ezvdf_.js","/_next/static/chunks/3enx74ouifseg.js","/_next/static/chunks/02m7uqem7_cm0.js","/_next/static/chunks/3xnqwtcs0m086.js","/_next/static/chunks/0njbwr6_u5vrf.js","/_next/static/chunks/078md0ja99fxe.js","/_next/static/chunks/2m7zx1h3ogrnv.js","/_next/static/chunks/3cgdinzv7h_c_.js","/_next/static/chunks/1ad7onw0ko-du.js","/_next/static/chunks/3w6u7-_luoiy7.js","/_next/static/chunks/3fibmfnwxxxpf.js","/_next/static/chunks/17n4z8lw1pwyr.js","/_next/static/chunks/2u-wrzchr0mp9.js","/_next/static/chunks/0a39rll0uaun7.js"],"CodeBlock",1] 72:I[500882,["/_next/static/chunks/2681zlkv3lyop.js","/_next/static/chunks/2_bnfr80cctuw.js","/_next/static/chunks/2kbo5axhrz1os.js","/_next/static/chunks/1xhl5-05_8ema.js","/_next/static/chunks/3dl6z98y327wm.js","/_next/static/chunks/0tg6tkaco7r13.js","/_next/static/chunks/2dh4fs0b-59w7.js","/_next/static/chunks/2enq7j8ezvdf_.js","/_next/static/chunks/3enx74ouifseg.js","/_next/static/chunks/02m7uqem7_cm0.js","/_next/static/chunks/3xnqwtcs0m086.js","/_next/static/chunks/0njbwr6_u5vrf.js","/_next/static/chunks/078md0ja99fxe.js","/_next/static/chunks/2m7zx1h3ogrnv.js","/_next/static/chunks/3cgdinzv7h_c_.js","/_next/static/chunks/1ad7onw0ko-du.js","/_next/static/chunks/3w6u7-_luoiy7.js","/_next/static/chunks/3fibmfnwxxxpf.js","/_next/static/chunks/17n4z8lw1pwyr.js","/_next/static/chunks/2u-wrzchr0mp9.js","/_next/static/chunks/0a39rll0uaun7.js"],"H3"] 84:I[804141,["/_next/static/chunks/2681zlkv3lyop.js","/_next/static/chunks/2_bnfr80cctuw.js","/_next/static/chunks/2kbo5axhrz1os.js","/_next/static/chunks/1xhl5-05_8ema.js","/_next/static/chunks/3dl6z98y327wm.js","/_next/static/chunks/0tg6tkaco7r13.js","/_next/static/chunks/2dh4fs0b-59w7.js","/_next/static/chunks/2enq7j8ezvdf_.js","/_next/static/chunks/3enx74ouifseg.js","/_next/static/chunks/02m7uqem7_cm0.js","/_next/static/chunks/3xnqwtcs0m086.js","/_next/static/chunks/0njbwr6_u5vrf.js","/_next/static/chunks/078md0ja99fxe.js","/_next/static/chunks/2m7zx1h3ogrnv.js","/_next/static/chunks/3cgdinzv7h_c_.js","/_next/static/chunks/1ad7onw0ko-du.js","/_next/static/chunks/3w6u7-_luoiy7.js","/_next/static/chunks/3fibmfnwxxxpf.js","/_next/static/chunks/17n4z8lw1pwyr.js","/_next/static/chunks/2u-wrzchr0mp9.js","/_next/static/chunks/0a39rll0uaun7.js"],"FeedbackFooter"] 85:I[125651,["/_next/static/chunks/2681zlkv3lyop.js","/_next/static/chunks/2_bnfr80cctuw.js","/_next/static/chunks/2kbo5axhrz1os.js","/_next/static/chunks/1xhl5-05_8ema.js","/_next/static/chunks/3dl6z98y327wm.js","/_next/static/chunks/0tg6tkaco7r13.js","/_next/static/chunks/2dh4fs0b-59w7.js","/_next/static/chunks/2enq7j8ezvdf_.js","/_next/static/chunks/3enx74ouifseg.js","/_next/static/chunks/02m7uqem7_cm0.js","/_next/static/chunks/3xnqwtcs0m086.js","/_next/static/chunks/0njbwr6_u5vrf.js","/_next/static/chunks/078md0ja99fxe.js","/_next/static/chunks/2m7zx1h3ogrnv.js","/_next/static/chunks/3cgdinzv7h_c_.js","/_next/static/chunks/1ad7onw0ko-du.js","/_next/static/chunks/3w6u7-_luoiy7.js","/_next/static/chunks/3fibmfnwxxxpf.js","/_next/static/chunks/17n4z8lw1pwyr.js","/_next/static/chunks/2u-wrzchr0mp9.js","/_next/static/chunks/0a39rll0uaun7.js"],"CopyPageButton"] 6a:["$","$L70",null,{"headings":[{"id":"servicename","text":"serviceName","level":3},{"id":"apitoken","text":"apiToken","level":3},{"id":"purgerules","text":"purgeRules","level":3},{"id":"defaultbuffertimems","text":"defaultBufferTimeMs","level":3},{"id":"devmode","text":"devMode","level":3},{"id":"debuglogging","text":"debugLogging","level":3}],"className":"mb-6 xl:hidden"}] 6b:["$","div",null,{"className":"prose prose-invert max-w-none","children":[["$","h1",null,{"className":"tracking-tight","children":"StellatePluginOptions"}],[["$","div",null,{"className":"bg-muted/50 mb-6 flex flex-wrap items-center gap-x-4 gap-y-2 rounded-lg border p-3 text-sm","children":[["$","a",null,{"href":"https://www.npmjs.com/package/@vendure-community/stellate-plugin","target":"_blank","rel":"noopener noreferrer","className":"text-muted-foreground hover:text-foreground inline-flex items-center gap-1.5 transition-colors","children":[["$","svg",null,{"xmlns":"http://www.w3.org/2000/svg","width":24,"height":24,"viewBox":"0 0 24 24","fill":"none","stroke":"currentColor","strokeWidth":2,"strokeLinecap":"round","strokeLinejoin":"round","className":"lucide lucide-package h-4 w-4","aria-hidden":"true","children":[["$","path","1a0edw",{"d":"M11 21.73a2 2 0 0 0 2 0l7-4A2 2 0 0 0 21 16V8a2 2 0 0 0-1-1.73l-7-4a2 2 0 0 0-2 0l-7 4A2 2 0 0 0 3 8v8a2 2 0 0 0 1 1.73z"}],["$","path","d0xqtd",{"d":"M12 22V12"}],["$","polyline","ousv84",{"points":"3.29 7 12 12 20.71 7"}],["$","path","1c824w",{"d":"m7.5 4.27 9 5.15"}],"$undefined"]}],["$","span",null,{"className":"font-mono","children":"@vendure-community/stellate-plugin"}],["$","svg",null,{"xmlns":"http://www.w3.org/2000/svg","width":24,"height":24,"viewBox":"0 0 24 24","fill":"none","stroke":"currentColor","strokeWidth":2,"strokeLinecap":"round","strokeLinejoin":"round","className":"lucide lucide-external-link h-3 w-3","aria-hidden":"true","children":[["$","path","1q9fwt",{"d":"M15 3h6v6"}],["$","path","gplh6r",{"d":"M10 14 21 3"}],["$","path","a6xqqp",{"d":"M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"}],"$undefined"]}]]}],["$","a",null,{"href":"https://github.com/vendurehq/community-plugins/blob/main/packages/stellate-plugin/src/types.ts#L9","target":"_blank","rel":"noopener noreferrer","className":"text-muted-foreground hover:text-foreground inline-flex items-center gap-1.5 transition-colors","children":[["$","svg",null,{"xmlns":"http://www.w3.org/2000/svg","width":24,"height":24,"viewBox":"0 0 24 24","fill":"none","stroke":"currentColor","strokeWidth":2,"strokeLinecap":"round","strokeLinejoin":"round","className":"lucide lucide-github h-4 w-4","aria-hidden":"true","children":[["$","path","tonef",{"d":"M15 22v-4a4.8 4.8 0 0 0-1-3.5c3 0 6-2 6-5.5.08-1.25-.27-2.48-1-3.5.28-1.15.28-2.35 0-3.5 0 0-1 0-3 1.5-2.64-.5-5.36-.5-8 0C6 2 5 2 5 2c-.3 1.15-.3 2.35 0 3.5A5.403 5.403 0 0 0 4 9c0 3.5 3 5.5 6 5.5-.39.49-.68 1.05-.85 1.65-.17.6-.22 1.23-.15 1.85v4"}],["$","path","9comsn",{"d":"M9 18c-4.51 2-5-2-7-2"}],"$undefined"]}],["$","span",null,{"children":"Source"}],["$","svg",null,{"xmlns":"http://www.w3.org/2000/svg","width":24,"height":24,"viewBox":"0 0 24 24","fill":"none","stroke":"currentColor","strokeWidth":2,"strokeLinecap":"round","strokeLinejoin":"round","className":"lucide lucide-external-link h-3 w-3","aria-hidden":"true","children":[["$","path","1q9fwt",{"d":"M15 3h6v6"}],["$","path","gplh6r",{"d":"M10 14 21 3"}],["$","path","a6xqqp",{"d":"M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"}],"$undefined"]}]]}],"$undefined","$undefined"]}],"\n",["$","p",null,{"children":"Configuration options for the StellatePlugin."}],"\n",["$","$L71",null,{"language":"ts","packageManagerSwitcher":true,"children":"// filename: Signature\ninterface StellatePluginOptions {\n serviceName: string;\n apiToken: string;\n purgeRules: PurgeRule[];\n defaultBufferTimeMs?: number;\n devMode?: boolean;\n debugLogging?: boolean;\n}"}],"\n",["$","div",null,{"className":"members-wrapper","children":[["$","$L72",null,{"id":"servicename","children":"serviceName"}],["$","div",null,{"className":"bg-muted/30 mb-4 overflow-x-auto rounded-lg border p-3","children":[["$","div",null,{"className":"flex flex-wrap items-start gap-x-3 gap-y-2","children":[["$","span",null,{"data-slot":"badge","data-variant":"outline","className":"h-5 gap-1 rounded-4xl border px-2 py-0.5 font-medium transition-all has-data-[icon=inline-end]:pr-1.5 has-data-[icon=inline-start]:pl-1.5 [&>svg]:size-3! inline-flex items-center justify-center w-fit whitespace-nowrap shrink-0 [&>svg]:pointer-events-none focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive overflow-hidden group/badge border-border text-foreground [a]:hover:bg-muted [a]:hover:text-muted-foreground font-mono text-xs","children":"property"}],"$L73","$undefined","$undefined"]}],false]}],"$L74","$L75","$L76","$L77","$L78","$L79","$L7a","$L7b","$L7c","$L7d","$L7e","$L7f","$L80","$L81","$L82","$L83"]}]]]}] 6c:["$","$L84",null,{"issueUrl":"https://github.com/vendurehq/community-plugins/issues/new?labels=documentation&title=Docs%3A%20Issue%20with%20%22StellatePluginOptions%22&body=**Page%20URL%3A**%20%2Fcurrent%2Fcommunity-plugins%2Fstellate-plugin%2Fstellate-plugin-options%0A%0A**Issue%20description%3A**%0A%0A","pageContext":{"pageUrl":"/current/community-plugins/stellate-plugin/stellate-plugin-options","pageTitle":"StellatePluginOptions","version":"current","packageId":"community-plugins"},"className":"mt-12"}] 6d:["$","nav",null,{"aria-label":"Pagination","className":"mt-12 flex items-center justify-between gap-4","children":[["$","$L7",null,{"href":"/current/community-plugins/stellate-plugin/purge-rule","className":"group border-border hover:border-foreground/30 flex flex-1 flex-col items-start gap-1 rounded-lg border p-4 transition-colors","children":[["$","span",null,{"className":"text-muted-foreground flex items-center gap-1 text-sm","children":[["$","svg",null,{"xmlns":"http://www.w3.org/2000/svg","width":24,"height":24,"viewBox":"0 0 24 24","fill":"none","stroke":"currentColor","strokeWidth":2,"strokeLinecap":"round","strokeLinejoin":"round","className":"lucide lucide-arrow-left h-4 w-4 transition-transform group-hover:-translate-x-1","aria-hidden":"true","children":[["$","path","1l729n",{"d":"m12 19-7-7 7-7"}],["$","path","x3x0zl",{"d":"M19 12H5"}],"$undefined"]}],"Previous"]}],["$","span",null,{"className":"text-foreground font-medium","children":"PurgeRule"}]]}],["$","$L7",null,{"href":"/current/community-plugins/stellate-plugin/stellate-service","className":"group border-border hover:border-foreground/30 flex flex-1 flex-col items-end gap-1 rounded-lg border p-4 transition-colors","children":[["$","span",null,{"className":"text-muted-foreground flex items-center gap-1 text-sm","children":["Next",["$","svg",null,{"xmlns":"http://www.w3.org/2000/svg","width":24,"height":24,"viewBox":"0 0 24 24","fill":"none","stroke":"currentColor","strokeWidth":2,"strokeLinecap":"round","strokeLinejoin":"round","className":"lucide lucide-arrow-right h-4 w-4 transition-transform group-hover:translate-x-1","aria-hidden":"true","children":[["$","path","1ays0h",{"d":"M5 12h14"}],["$","path","xquz4c",{"d":"m12 5 7 7-7 7"}],"$undefined"]}]]}],["$","span",null,{"className":"text-foreground font-medium","children":"StellateService"}]]}]]}] 6e:["$","div",null,{"className":"text-muted-foreground flex flex-wrap items-center gap-x-2 text-sm mt-8","children":[["$","span",null,{"children":"Edited Mar 31, 2026"}],["$","span",null,{"className":"text-muted-foreground/50","children":"·"}],["$","a",null,{"href":"https://github.com/vendurehq/community-plugins/edit/main/docs/docs/reference/stellate-plugin/stellate-plugin-options.mdx","target":"_blank","rel":"noopener noreferrer","className":"hover:text-foreground inline-flex items-center gap-1 transition-colors","children":["Edit this page",["$","svg",null,{"xmlns":"http://www.w3.org/2000/svg","width":24,"height":24,"viewBox":"0 0 24 24","fill":"none","stroke":"currentColor","strokeWidth":2,"strokeLinecap":"round","strokeLinejoin":"round","className":"lucide lucide-external-link h-3 w-3","aria-hidden":"true","children":[["$","path","1q9fwt",{"d":"M15 3h6v6"}],["$","path","gplh6r",{"d":"M10 14 21 3"}],["$","path","a6xqqp",{"d":"M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"}],"$undefined"]}]]}]]}] 86:T7ad,--- title: "StellatePluginOptions" generated: true --- Configuration options for the StellatePlugin. ```ts title="Signature" 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](/reference/stellate-plugin/purge-rule#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.

6f:["$","aside",null,{"className":"hidden xl:block","children":["$","div",null,{"className":"sticky top-8 h-[calc(100svh-6.5rem)] w-64 shrink-0","children":["$","$L65",null,{"className":"h-full w-full","children":["$","div",null,{"className":"w-64 overflow-hidden","children":[["$","div",null,{"className":"mb-6","children":["$","$L85",null,{"rawContent":"$86"}]}],["$","div",null,{"className":"from-brand/5 via-brand/10 to-brand/5 border-brand/20 rounded-lg border bg-gradient-to-br p-4 mb-6","children":[["$","div",null,{"className":"mb-3 flex items-center gap-2","children":[["$","div",null,{"className":"bg-brand/10 flex size-8 items-center justify-center rounded-md","children":["$","svg",null,{"xmlns":"http://www.w3.org/2000/svg","width":24,"height":24,"viewBox":"0 0 24 24","fill":"none","stroke":"currentColor","strokeWidth":2,"strokeLinecap":"round","strokeLinejoin":"round","className":"lucide lucide-heart-handshake text-brand size-4","aria-hidden":"true","children":[["$","path","17lmqv",{"d":"M19.414 14.414C21 12.828 22 11.5 22 9.5a5.5 5.5 0 0 0-9.591-3.676.6.6 0 0 1-.818.001A5.5 5.5 0 0 0 2 9.5c0 2.3 1.5 4 3 5.5l5.535 5.362a2 2 0 0 0 2.879.052 2.12 2.12 0 0 0-.004-3 2.124 2.124 0 1 0 3-3 2.124 2.124 0 0 0 3.004 0 2 2 0 0 0 0-2.828l-1.881-1.882a2.41 2.41 0 0 0-3.409 0l-1.71 1.71a2 2 0 0 1-2.828 0 2 2 0 0 1 0-2.828l2.823-2.762"}],"$undefined"]}]}],["$","span",null,{"className":"text-sm font-semibold","children":"Past the docs?"}]]}],["$","p",null,{"className":"text-muted-foreground mb-4 text-sm leading-relaxed","children":"Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure."}],"$L87"]}],"$L88"]}]}]}]}]