[{"data":1,"prerenderedAt":1599},["ShallowReactive",2],{"navigation":3,"docs-path-index":340,"-docs-modules-scheduler-overview":446,"-docs-modules-scheduler-overview-surround":1594},[4],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":64},"Docs","i-lucide-book-marked","\u002Fdocs","docs",[10,30,65,293,318],{"title":11,"path":12,"stem":13,"children":14,"icon":29},"Getting Started","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started\u002F1.index",[15,17,21,25],{"title":16,"path":12,"stem":13},"Introduction",{"title":18,"path":19,"stem":20},"Installation","\u002Fdocs\u002Fgetting-started\u002Finstallation","docs\u002F1.getting-started\u002F2.installation",{"title":22,"path":23,"stem":24},"Examples","\u002Fdocs\u002Fgetting-started\u002Fexamples","docs\u002F1.getting-started\u002F3.examples",{"title":26,"path":27,"stem":28},"Project Generator","\u002Fdocs\u002Fgetting-started\u002Fproject-generator","docs\u002F1.getting-started\u002F4.project-generator","i-lucide-rocket",{"title":31,"icon":32,"path":33,"stem":34,"children":35,"page":64},"Core features","i-lucide-square-function","\u002Fdocs\u002Fcore-features","docs\u002F2.core-features",[36,40,44,48,52,56,60],{"title":37,"path":38,"stem":39},"Configuration","\u002Fdocs\u002Fcore-features\u002Fconfiguration","docs\u002F2.core-features\u002F0.configuration",{"title":41,"path":42,"stem":43},"Dependency Injection","\u002Fdocs\u002Fcore-features\u002Fcontainer","docs\u002F2.core-features\u002F1.container",{"title":45,"path":46,"stem":47},"Controllers","\u002Fdocs\u002Fcore-features\u002Fcontrollers","docs\u002F2.core-features\u002F2.controllers",{"title":49,"path":50,"stem":51},"Middlewares","\u002Fdocs\u002Fcore-features\u002Fmiddlewares","docs\u002F2.core-features\u002F3.middlewares",{"title":53,"path":54,"stem":55},"Validation","\u002Fdocs\u002Fcore-features\u002Fvalidation","docs\u002F2.core-features\u002F4.validation",{"title":57,"path":58,"stem":59},"Introspection","\u002Fdocs\u002Fcore-features\u002Fintrospection","docs\u002F2.core-features\u002F5.introspection",{"title":61,"path":62,"stem":63},"Health Checks","\u002Fdocs\u002Fcore-features\u002Fhealth","docs\u002F2.core-features\u002F6.health",false,{"title":66,"icon":67,"defaultOpen":68,"path":69,"stem":70,"children":71,"page":64},"Modules","i-lucide-boxes",true,"\u002Fdocs\u002Fmodules","docs\u002F3.modules",[72,89,100,116,135,154,177,191,206,214,229,240,255,274,282],{"title":73,"icon":64,"defaultOpen":64,"path":74,"stem":75,"children":76,"page":64},"Auth","\u002Fdocs\u002Fmodules\u002Fauth","docs\u002F3.modules\u002F1.auth",[77,81,85],{"title":78,"path":79,"stem":80},"Overview","\u002Fdocs\u002Fmodules\u002Fauth\u002Foverview","docs\u002F3.modules\u002F1.auth\u002F0.overview",{"title":82,"path":83,"stem":84},"Decorators","\u002Fdocs\u002Fmodules\u002Fauth\u002Fdecorators","docs\u002F3.modules\u002F1.auth\u002F1.decorators",{"title":86,"path":87,"stem":88},"API Reference","\u002Fdocs\u002Fmodules\u002Fauth\u002Fapi","docs\u002F3.modules\u002F1.auth\u002F2.api",{"title":90,"icon":64,"defaultOpen":64,"path":91,"stem":92,"children":93,"page":64},"Devtools","\u002Fdocs\u002Fmodules\u002Fdevtools","docs\u002F3.modules\u002F10.devtools",[94,97],{"title":78,"path":95,"stem":96},"\u002Fdocs\u002Fmodules\u002Fdevtools\u002Foverview","docs\u002F3.modules\u002F10.devtools\u002F0.overview",{"title":37,"path":98,"stem":99},"\u002Fdocs\u002Fmodules\u002Fdevtools\u002Fconfiguration","docs\u002F3.modules\u002F10.devtools\u002F1.configuration",{"title":101,"icon":64,"defaultOpen":64,"path":102,"stem":103,"children":104,"page":64},"Telemetry","\u002Fdocs\u002Fmodules\u002Ftelemetry","docs\u002F3.modules\u002F11.telemetry",[105,108,112],{"title":78,"path":106,"stem":107},"\u002Fdocs\u002Fmodules\u002Ftelemetry\u002Foverview","docs\u002F3.modules\u002F11.telemetry\u002F0.overview",{"title":109,"path":110,"stem":111},"API","\u002Fdocs\u002Fmodules\u002Ftelemetry\u002Fapi","docs\u002F3.modules\u002F11.telemetry\u002F1.api",{"title":113,"path":114,"stem":115},"Instrumentation","\u002Fdocs\u002Fmodules\u002Ftelemetry\u002Finstrumentation","docs\u002F3.modules\u002F11.telemetry\u002F2.instrumentation",{"title":117,"icon":64,"defaultOpen":64,"path":118,"stem":119,"children":120,"page":64},"Queue","\u002Fdocs\u002Fmodules\u002Fqueue","docs\u002F3.modules\u002F12.queue",[121,124,128,132],{"title":78,"path":122,"stem":123},"\u002Fdocs\u002Fmodules\u002Fqueue\u002Foverview","docs\u002F3.modules\u002F12.queue\u002F0.overview",{"title":125,"path":126,"stem":127},"Consumers","\u002Fdocs\u002Fmodules\u002Fqueue\u002Fconsumers","docs\u002F3.modules\u002F12.queue\u002F1.consumers",{"title":129,"path":130,"stem":131},"Strategies","\u002Fdocs\u002Fmodules\u002Fqueue\u002Fstrategies","docs\u002F3.modules\u002F12.queue\u002F2.strategies",{"title":109,"path":133,"stem":134},"\u002Fdocs\u002Fmodules\u002Fqueue\u002Fapi","docs\u002F3.modules\u002F12.queue\u002F3.api",{"title":136,"icon":64,"defaultOpen":64,"path":137,"stem":138,"children":139,"page":64},"Scheduler","\u002Fdocs\u002Fmodules\u002Fscheduler","docs\u002F3.modules\u002F13.scheduler",[140,143,147,151],{"title":78,"path":141,"stem":142},"\u002Fdocs\u002Fmodules\u002Fscheduler\u002Foverview","docs\u002F3.modules\u002F13.scheduler\u002F0.overview",{"title":144,"path":145,"stem":146},"Jobs","\u002Fdocs\u002Fmodules\u002Fscheduler\u002Fjobs","docs\u002F3.modules\u002F13.scheduler\u002F1.jobs",{"title":148,"path":149,"stem":150},"Clustering","\u002Fdocs\u002Fmodules\u002Fscheduler\u002Fclustering","docs\u002F3.modules\u002F13.scheduler\u002F2.clustering",{"title":109,"path":152,"stem":153},"\u002Fdocs\u002Fmodules\u002Fscheduler\u002Fapi","docs\u002F3.modules\u002F13.scheduler\u002F3.api",{"title":155,"icon":64,"defaultOpen":64,"path":156,"stem":157,"children":158,"page":64},"Testing","\u002Fdocs\u002Fmodules\u002Ftesting","docs\u002F3.modules\u002F14.testing",[159,162,166,170,174],{"title":78,"path":160,"stem":161},"\u002Fdocs\u002Fmodules\u002Ftesting\u002Foverview","docs\u002F3.modules\u002F14.testing\u002F0.overview",{"title":163,"path":164,"stem":165},"Requests","\u002Fdocs\u002Fmodules\u002Ftesting\u002Frequests","docs\u002F3.modules\u002F14.testing\u002F1.requests",{"title":167,"path":168,"stem":169},"Dependencies","\u002Fdocs\u002Fmodules\u002Ftesting\u002Fdependencies","docs\u002F3.modules\u002F14.testing\u002F2.dependencies",{"title":171,"path":172,"stem":173},"Extensions","\u002Fdocs\u002Fmodules\u002Ftesting\u002Fextensions","docs\u002F3.modules\u002F14.testing\u002F3.extensions",{"title":109,"path":175,"stem":176},"\u002Fdocs\u002Fmodules\u002Ftesting\u002Fapi","docs\u002F3.modules\u002F14.testing\u002F4.api",{"title":178,"icon":64,"defaultOpen":64,"path":179,"stem":180,"children":181,"page":64},"Client","\u002Fdocs\u002Fmodules\u002Fclient","docs\u002F3.modules\u002F15.client",[182,185,188],{"title":78,"path":183,"stem":184},"\u002Fdocs\u002Fmodules\u002Fclient\u002Foverview","docs\u002F3.modules\u002F15.client\u002F0.overview",{"title":163,"path":186,"stem":187},"\u002Fdocs\u002Fmodules\u002Fclient\u002Frequests","docs\u002F3.modules\u002F15.client\u002F1.requests",{"title":109,"path":189,"stem":190},"\u002Fdocs\u002Fmodules\u002Fclient\u002Fapi","docs\u002F3.modules\u002F15.client\u002F2.api",{"title":192,"icon":64,"defaultOpen":64,"path":193,"stem":194,"children":195,"page":64},"Logger","\u002Fdocs\u002Fmodules\u002Flogger","docs\u002F3.modules\u002F2.logger",[196,199,203],{"title":78,"path":197,"stem":198},"\u002Fdocs\u002Fmodules\u002Flogger\u002Foverview","docs\u002F3.modules\u002F2.logger\u002F0.overview",{"title":200,"path":201,"stem":202},"Drains & Adapters","\u002Fdocs\u002Fmodules\u002Flogger\u002Fdrivers","docs\u002F3.modules\u002F2.logger\u002F1.drivers",{"title":109,"path":204,"stem":205},"\u002Fdocs\u002Fmodules\u002Flogger\u002Fapi","docs\u002F3.modules\u002F2.logger\u002F2.api",{"title":207,"icon":64,"defaultOpen":64,"path":208,"stem":209,"children":210,"page":64},"Serverless","\u002Fdocs\u002Fmodules\u002Fserverless","docs\u002F3.modules\u002F3.serverless",[211],{"title":78,"path":212,"stem":213},"\u002Fdocs\u002Fmodules\u002Fserverless\u002Foverview","docs\u002F3.modules\u002F3.serverless\u002F0.overview",{"title":215,"icon":64,"defaultOpen":64,"path":216,"stem":217,"children":218,"page":64},"Storage","\u002Fdocs\u002Fmodules\u002Fstorage","docs\u002F3.modules\u002F4.storage",[219,222,226],{"title":78,"path":220,"stem":221},"\u002Fdocs\u002Fmodules\u002Fstorage\u002Foverview","docs\u002F3.modules\u002F4.storage\u002F0.overview",{"title":223,"path":224,"stem":225},"Drivers","\u002Fdocs\u002Fmodules\u002Fstorage\u002Fdrivers","docs\u002F3.modules\u002F4.storage\u002F1.drivers",{"title":109,"path":227,"stem":228},"\u002Fdocs\u002Fmodules\u002Fstorage\u002Fapi","docs\u002F3.modules\u002F4.storage\u002F2.api",{"title":230,"icon":64,"defaultOpen":64,"path":231,"stem":232,"children":233,"page":64},"Web Sockets","\u002Fdocs\u002Fmodules\u002Fweb-sockets","docs\u002F3.modules\u002F5.web-sockets",[234,237],{"title":78,"path":235,"stem":236},"\u002Fdocs\u002Fmodules\u002Fweb-sockets\u002Foverview","docs\u002F3.modules\u002F5.web-sockets\u002F0.overview",{"title":109,"path":238,"stem":239},"\u002Fdocs\u002Fmodules\u002Fweb-sockets\u002Fapi","docs\u002F3.modules\u002F5.web-sockets\u002F1.api",{"title":241,"icon":64,"defaultOpen":64,"path":242,"stem":243,"children":244,"page":64},"Schema","\u002Fdocs\u002Fmodules\u002Fschema","docs\u002F3.modules\u002F6.schema",[245,248,251],{"title":78,"path":246,"stem":247},"\u002Fdocs\u002Fmodules\u002Fschema\u002Foverview","docs\u002F3.modules\u002F6.schema\u002F0.overview",{"title":82,"path":249,"stem":250},"\u002Fdocs\u002Fmodules\u002Fschema\u002Fdecorators","docs\u002F3.modules\u002F6.schema\u002F1.decorators",{"title":252,"path":253,"stem":254},"Scalar","\u002Fdocs\u002Fmodules\u002Fschema\u002Fscalar","docs\u002F3.modules\u002F6.schema\u002F2.scalar",{"title":256,"icon":64,"defaultOpen":64,"path":257,"stem":258,"children":259,"page":64},"Nitro","\u002Fdocs\u002Fmodules\u002Fnitro","docs\u002F3.modules\u002F7.nitro",[260,263,266,270],{"title":78,"path":261,"stem":262},"\u002Fdocs\u002Fmodules\u002Fnitro\u002Foverview","docs\u002F3.modules\u002F7.nitro\u002F0.overview",{"title":215,"path":264,"stem":265},"\u002Fdocs\u002Fmodules\u002Fnitro\u002Fstorage","docs\u002F3.modules\u002F7.nitro\u002F1.storage",{"title":267,"path":268,"stem":269},"File-Based Routes","\u002Fdocs\u002Fmodules\u002Fnitro\u002Ffile-based-routes","docs\u002F3.modules\u002F7.nitro\u002F2.file-based-routes",{"title":271,"path":272,"stem":273},"Middleware","\u002Fdocs\u002Fmodules\u002Fnitro\u002Fmiddleware","docs\u002F3.modules\u002F7.nitro\u002F3.middleware",{"title":275,"icon":64,"defaultOpen":64,"path":276,"stem":277,"children":278,"page":64},"Vite","\u002Fdocs\u002Fmodules\u002Fvite","docs\u002F3.modules\u002F8.vite",[279],{"title":78,"path":280,"stem":281},"\u002Fdocs\u002Fmodules\u002Fvite\u002Foverview","docs\u002F3.modules\u002F8.vite\u002F0.overview",{"title":283,"icon":64,"defaultOpen":64,"path":284,"stem":285,"children":286,"page":64},"Cache","\u002Fdocs\u002Fmodules\u002Fcache","docs\u002F3.modules\u002F9.cache",[287,290],{"title":78,"path":288,"stem":289},"\u002Fdocs\u002Fmodules\u002Fcache\u002Foverview","docs\u002F3.modules\u002F9.cache\u002F0.overview",{"title":109,"path":291,"stem":292},"\u002Fdocs\u002Fmodules\u002Fcache\u002Fapi","docs\u002F3.modules\u002F9.cache\u002F1.api",{"title":294,"icon":295,"path":296,"stem":297,"children":298,"page":64},"Deployment","i-lucide-cloud-upload","\u002Fdocs\u002Fdeployment","docs\u002F4.deployment",[299,302,306,310,314],{"title":78,"path":300,"stem":301},"\u002Fdocs\u002Fdeployment\u002Foverview","docs\u002F4.deployment\u002F0.overview",{"title":303,"path":304,"stem":305},"Vercel","\u002Fdocs\u002Fdeployment\u002Fvercel","docs\u002F4.deployment\u002F1.vercel",{"title":307,"path":308,"stem":309},"AWS Lambda","\u002Fdocs\u002Fdeployment\u002Faws-lambda","docs\u002F4.deployment\u002F2.aws-lambda",{"title":311,"path":312,"stem":313},"Azure Functions","\u002Fdocs\u002Fdeployment\u002Fazure-functions","docs\u002F4.deployment\u002F3.azure-functions",{"title":315,"path":316,"stem":317},"Node.js Server","\u002Fdocs\u002Fdeployment\u002Fnode-server","docs\u002F4.deployment\u002F4.node-server",{"title":319,"icon":320,"path":321,"stem":322,"children":323,"page":64},"Advanced","i-lucide-brain","\u002Fdocs\u002Fadvanced","docs\u002F99.advanced",[324,328,332,336],{"title":325,"path":326,"stem":327},"Custom Decorator","\u002Fdocs\u002Fadvanced\u002Fcustom-decorator","docs\u002F99.advanced\u002F1.custom-decorator",{"title":329,"path":330,"stem":331},"Plugins","\u002Fdocs\u002Fadvanced\u002Fcustom-plugin","docs\u002F99.advanced\u002F2.custom-plugin",{"title":333,"path":334,"stem":335},"Custom CLI Command","\u002Fdocs\u002Fadvanced\u002Fcustom-cli-command","docs\u002F99.advanced\u002F3.custom-cli-command",{"title":337,"path":338,"stem":339},"Writing a Recipe","\u002Fdocs\u002Fadvanced\u002Fwriting-a-recipe","docs\u002F99.advanced\u002F4.writing-a-recipe",[341,343,345,346,347,348,349,351,352,353,354,355,356,357,358,360,362,363,364,365,367,368,369,371,372,373,374,376,377,378,379,380,382,383,384,385,386,388,389,390,391,392,393,395,396,397,398,400,401,402,403,405,406,408,409,410,411,413,414,415,417,418,419,420,422,423,424,425,426,428,429,431,432,433,435,436,437,438,439,440,442,443,444,445],{"path":342},"\u002Fdocs\u002F.navigation",{"path":344},"\u002Fdocs\u002Fgetting-started\u002F.navigation",{"path":12},{"path":19},{"path":23},{"path":27},{"path":350},"\u002Fdocs\u002Fcore-features\u002F.navigation",{"path":38},{"path":42},{"path":46},{"path":50},{"path":54},{"path":58},{"path":62},{"path":359},"\u002Fdocs\u002Fmodules\u002F.navigation",{"path":361},"\u002Fdocs\u002Fmodules\u002Fauth\u002F.navigation",{"path":79},{"path":83},{"path":87},{"path":366},"\u002Fdocs\u002Fmodules\u002Fdevtools\u002F.navigation",{"path":95},{"path":98},{"path":370},"\u002Fdocs\u002Fmodules\u002Ftelemetry\u002F.navigation",{"path":106},{"path":110},{"path":114},{"path":375},"\u002Fdocs\u002Fmodules\u002Fqueue\u002F.navigation",{"path":122},{"path":126},{"path":130},{"path":133},{"path":381},"\u002Fdocs\u002Fmodules\u002Fscheduler\u002F.navigation",{"path":141},{"path":145},{"path":149},{"path":152},{"path":387},"\u002Fdocs\u002Fmodules\u002Ftesting\u002F.navigation",{"path":160},{"path":164},{"path":168},{"path":172},{"path":175},{"path":394},"\u002Fdocs\u002Fmodules\u002Fclient\u002F.navigation",{"path":183},{"path":186},{"path":189},{"path":399},"\u002Fdocs\u002Fmodules\u002Flogger\u002F.navigation",{"path":197},{"path":201},{"path":204},{"path":404},"\u002Fdocs\u002Fmodules\u002Fserverless\u002F.navigation",{"path":212},{"path":407},"\u002Fdocs\u002Fmodules\u002Fstorage\u002F.navigation",{"path":220},{"path":224},{"path":227},{"path":412},"\u002Fdocs\u002Fmodules\u002Fweb-sockets\u002F.navigation",{"path":235},{"path":238},{"path":416},"\u002Fdocs\u002Fmodules\u002Fschema\u002F.navigation",{"path":246},{"path":249},{"path":253},{"path":421},"\u002Fdocs\u002Fmodules\u002Fnitro\u002F.navigation",{"path":261},{"path":264},{"path":268},{"path":272},{"path":427},"\u002Fdocs\u002Fmodules\u002Fvite\u002F.navigation",{"path":280},{"path":430},"\u002Fdocs\u002Fmodules\u002Fcache\u002F.navigation",{"path":288},{"path":291},{"path":434},"\u002Fdocs\u002Fdeployment\u002F.navigation",{"path":300},{"path":304},{"path":308},{"path":312},{"path":316},{"path":441},"\u002Fdocs\u002Fadvanced\u002F.navigation",{"path":326},{"path":330},{"path":334},{"path":338},{"id":447,"title":78,"body":448,"description":1588,"extension":1589,"links":1590,"meta":1591,"navigation":68,"path":141,"seo":1592,"stem":142,"__hash__":1593},"docs\u002Fdocs\u002F3.modules\u002F13.scheduler\u002F0.overview.md",{"type":449,"value":450,"toc":1582},"minimark",[451,455,467,527,530,534,601,604,640,646,650,1523,1527,1552,1556,1578],[452,453,454],"p",{},"The Scheduler module runs recurring work inside a Vercube app: cron expressions, fixed intervals, or both. It is built for apps that run as more than one process. Every replica computes the same schedule from the same code, and a shared store decides which replica runs each occurrence, so a nightly billing job runs once at 03:00 whether you have one pod or forty.",[452,456,457,458,462,463,466],{},"The rule behind it is to separate ",[459,460,461],"strong",{},"when"," something runs from ",[459,464,465],{},"who"," runs it:",[468,469,470,489],"table",{},[471,472,473],"thead",{},[474,475,476,480,483,486],"tr",{},[477,478,479],"th",{},"Scope",[477,481,482],{},"Who runs an occurrence",[477,484,485],{},"Needs a store",[477,487,488],{},"Use it for",[490,491,492,511],"tbody",{},[474,493,494,502,505,508],{},[495,496,497,501],"td",{},[498,499,500],"code",{},"cluster"," (default)",[495,503,504],{},"exactly one replica",[495,506,507],{},"yes",[495,509,510],{},"billing, reports, emails, anything with side effects",[474,512,513,518,521,524],{},[495,514,515],{},[498,516,517],{},"instance",[495,519,520],{},"every replica",[495,522,523],{},"no",[495,525,526],{},"clearing a local cache, refreshing in-memory config",[452,528,529],{},"A cluster job without a distributed store refuses to start in production instead of quietly running on every pod.",[531,532,18],"h2",{"id":533},"installation",[535,536,537,566,584],"code-group",{},[538,539,545],"pre",{"className":540,"code":541,"filename":542,"language":543,"meta":544,"style":544},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","$ pnpm add @vercube\u002Fscheduler\n","pnpm","bash","",[498,546,547],{"__ignoreMap":544},[548,549,552,556,560,563],"span",{"class":550,"line":551},"line",1,[548,553,555],{"class":554},"sBMFI","$",[548,557,559],{"class":558},"sfazB"," pnpm",[548,561,562],{"class":558}," add",[548,564,565],{"class":558}," @vercube\u002Fscheduler\n",[538,567,570],{"className":540,"code":568,"filename":569,"language":543,"meta":544,"style":544},"$ npm install @vercube\u002Fscheduler\n","npm",[498,571,572],{"__ignoreMap":544},[548,573,574,576,579,582],{"class":550,"line":551},[548,575,555],{"class":554},[548,577,578],{"class":558}," npm",[548,580,581],{"class":558}," install",[548,583,565],{"class":558},[538,585,588],{"className":540,"code":586,"filename":587,"language":543,"meta":544,"style":544},"$ bun install @vercube\u002Fscheduler\n","bun",[498,589,590],{"__ignoreMap":544},[548,591,592,594,597,599],{"class":550,"line":551},[548,593,555],{"class":554},[548,595,596],{"class":558}," bun",[548,598,581],{"class":558},[548,600,565],{"class":558},[452,602,603],{},"Install the client of the store your replicas share. Both are optional dependencies:",[535,605,606,623],{},[538,607,610],{"className":540,"code":608,"filename":609,"language":543,"meta":544,"style":544},"$ pnpm add ioredis\n","Redis",[498,611,612],{"__ignoreMap":544},[548,613,614,616,618,620],{"class":550,"line":551},[548,615,555],{"class":554},[548,617,559],{"class":558},[548,619,562],{"class":558},[548,621,622],{"class":558}," ioredis\n",[538,624,627],{"className":540,"code":625,"filename":626,"language":543,"meta":544,"style":544},"$ pnpm add pg\n","PostgreSQL",[498,628,629],{"__ignoreMap":544},[548,630,631,633,635,637],{"class":550,"line":551},[548,632,555],{"class":554},[548,634,559],{"class":558},[548,636,562],{"class":558},[548,638,639],{"class":558}," pg\n",[452,641,642,645],{},[498,643,644],{},"MemoryStore"," needs nothing, and coordinates a single process only.",[531,647,649],{"id":648},"quick-start","Quick Start",[651,652,653,658,665,941,955,959,976,1407,1414,1418,1421],"steps",{},[654,655,657],"h3",{"id":656},"register-the-plugin","Register the plugin",[452,659,660,661,664],{},"The plugin binds the ",[498,662,663],{},"SchedulerManager",", mounts the store and arms the timers once the app is up.",[538,666,671],{"className":667,"code":668,"filename":669,"language":670,"meta":544,"style":544},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","import { defineConfig } from '@vercube\u002Fcore';\nimport { defineSchedulerStore, SchedulerPlugin } from '@vercube\u002Fscheduler';\nimport { RedisStore } from '@vercube\u002Fscheduler\u002Fstores\u002FRedisStore';\n\nexport default defineConfig({\n  plugins: [\n    [\n      SchedulerPlugin,\n      {\n        store: defineSchedulerStore({\n          store: RedisStore,\n          initOptions: { url: process.env.REDIS_URL },\n        }),\n        defaults: { timezone: 'Europe\u002FWarsaw' },\n      },\n    ],\n  ],\n});\n","vercube.config.ts","ts",[498,672,673,705,734,757,763,781,794,800,809,815,829,841,873,884,909,915,923,931],{"__ignoreMap":544},[548,674,675,679,683,687,690,693,696,699,702],{"class":550,"line":551},[548,676,678],{"class":677},"s7zQu","import",[548,680,682],{"class":681},"sMK4o"," {",[548,684,686],{"class":685},"sTEyZ"," defineConfig",[548,688,689],{"class":681}," }",[548,691,692],{"class":677}," from",[548,694,695],{"class":681}," '",[548,697,698],{"class":558},"@vercube\u002Fcore",[548,700,701],{"class":681},"'",[548,703,704],{"class":681},";\n",[548,706,708,710,712,715,718,721,723,725,727,730,732],{"class":550,"line":707},2,[548,709,678],{"class":677},[548,711,682],{"class":681},[548,713,714],{"class":685}," defineSchedulerStore",[548,716,717],{"class":681},",",[548,719,720],{"class":685}," SchedulerPlugin",[548,722,689],{"class":681},[548,724,692],{"class":677},[548,726,695],{"class":681},[548,728,729],{"class":558},"@vercube\u002Fscheduler",[548,731,701],{"class":681},[548,733,704],{"class":681},[548,735,737,739,741,744,746,748,750,753,755],{"class":550,"line":736},3,[548,738,678],{"class":677},[548,740,682],{"class":681},[548,742,743],{"class":685}," RedisStore",[548,745,689],{"class":681},[548,747,692],{"class":677},[548,749,695],{"class":681},[548,751,752],{"class":558},"@vercube\u002Fscheduler\u002Fstores\u002FRedisStore",[548,754,701],{"class":681},[548,756,704],{"class":681},[548,758,760],{"class":550,"line":759},4,[548,761,762],{"emptyLinePlaceholder":68},"\n",[548,764,766,769,772,775,778],{"class":550,"line":765},5,[548,767,768],{"class":677},"export",[548,770,771],{"class":677}," default",[548,773,686],{"class":774},"s2Zo4",[548,776,777],{"class":685},"(",[548,779,780],{"class":681},"{\n",[548,782,784,788,791],{"class":550,"line":783},6,[548,785,787],{"class":786},"swJcz","  plugins",[548,789,790],{"class":681},":",[548,792,793],{"class":685}," [\n",[548,795,797],{"class":550,"line":796},7,[548,798,799],{"class":685},"    [\n",[548,801,803,806],{"class":550,"line":802},8,[548,804,805],{"class":685},"      SchedulerPlugin",[548,807,808],{"class":681},",\n",[548,810,812],{"class":550,"line":811},9,[548,813,814],{"class":681},"      {\n",[548,816,818,821,823,825,827],{"class":550,"line":817},10,[548,819,820],{"class":786},"        store",[548,822,790],{"class":681},[548,824,714],{"class":774},[548,826,777],{"class":685},[548,828,780],{"class":681},[548,830,832,835,837,839],{"class":550,"line":831},11,[548,833,834],{"class":786},"          store",[548,836,790],{"class":681},[548,838,743],{"class":685},[548,840,808],{"class":681},[548,842,844,847,849,851,854,856,859,862,865,867,870],{"class":550,"line":843},12,[548,845,846],{"class":786},"          initOptions",[548,848,790],{"class":681},[548,850,682],{"class":681},[548,852,853],{"class":786}," url",[548,855,790],{"class":681},[548,857,858],{"class":685}," process",[548,860,861],{"class":681},".",[548,863,864],{"class":685},"env",[548,866,861],{"class":681},[548,868,869],{"class":685},"REDIS_URL ",[548,871,872],{"class":681},"},\n",[548,874,876,879,882],{"class":550,"line":875},13,[548,877,878],{"class":681},"        }",[548,880,881],{"class":685},")",[548,883,808],{"class":681},[548,885,887,890,892,894,897,899,901,904,906],{"class":550,"line":886},14,[548,888,889],{"class":786},"        defaults",[548,891,790],{"class":681},[548,893,682],{"class":681},[548,895,896],{"class":786}," timezone",[548,898,790],{"class":681},[548,900,695],{"class":681},[548,902,903],{"class":558},"Europe\u002FWarsaw",[548,905,701],{"class":681},[548,907,908],{"class":681}," },\n",[548,910,912],{"class":550,"line":911},15,[548,913,914],{"class":681},"      },\n",[548,916,918,921],{"class":550,"line":917},16,[548,919,920],{"class":685},"    ]",[548,922,808],{"class":681},[548,924,926,929],{"class":550,"line":925},17,[548,927,928],{"class":685},"  ]",[548,930,808],{"class":681},[548,932,934,937,939],{"class":550,"line":933},18,[548,935,936],{"class":681},"}",[548,938,881],{"class":685},[548,940,704],{"class":681},[452,942,943,944,946,947,950,951,954],{},"Listing the plugin in ",[498,945,669],{},", rather than calling ",[498,948,949],{},"app.addPlugin()",", is also what adds the ",[498,952,953],{},"vercube scheduler"," commands to the CLI.",[654,956,958],{"id":957},"declare-jobs","Declare jobs",[452,960,961,964,965,968,969,861],{},[498,962,963],{},"@Cron()"," and ",[498,966,967],{},"@Every()"," turn a method into a job. The method receives a ",[970,971,973],"a",{"href":972},"\u002Fdocs\u002Fmodules\u002Fscheduler\u002Fjobs#the-job-context",[498,974,975],{},"JobContext",[538,977,980],{"className":667,"code":978,"filename":979,"language":670,"meta":544,"style":544},"import { Inject } from '@vercube\u002Fdi';\nimport { Cron, Every } from '@vercube\u002Fscheduler';\nimport { InvoiceService } from '..\u002Fservices\u002FInvoiceService';\nimport type { SchedulerTypes } from '@vercube\u002Fscheduler';\n\nexport class BillingJobs {\n  @Inject(InvoiceService)\n  private gInvoices!: InvoiceService;\n\n  \u002F\u002F once per day across the whole cluster, on Warsaw wall clock time\n  @Cron('0 3 * * *', { name: 'billing.close-day' })\n  public async closeDay(ctx: SchedulerTypes.JobContext): Promise\u003Cvoid> {\n    for (const batch of await this.gInvoices.openBatches()) {\n      ctx.signal.throwIfAborted();\n      await this.gInvoices.close(batch, { idempotencyKey: ctx.occurrenceId });\n    }\n  }\n\n  \u002F\u002F every replica clears its own cache\n  @Every('5m', { scope: 'instance' })\n  public flushLocalCache(): void {\n    this.gInvoices.clearCache();\n  }\n}\n","src\u002Fjobs\u002FBillingJobs.ts",[498,981,982,1004,1030,1052,1076,1080,1094,1105,1120,1124,1130,1167,1209,1245,1265,1307,1312,1317,1321,1327,1363,1379,1396,1401],{"__ignoreMap":544},[548,983,984,986,988,991,993,995,997,1000,1002],{"class":550,"line":551},[548,985,678],{"class":677},[548,987,682],{"class":681},[548,989,990],{"class":685}," Inject",[548,992,689],{"class":681},[548,994,692],{"class":677},[548,996,695],{"class":681},[548,998,999],{"class":558},"@vercube\u002Fdi",[548,1001,701],{"class":681},[548,1003,704],{"class":681},[548,1005,1006,1008,1010,1013,1015,1018,1020,1022,1024,1026,1028],{"class":550,"line":707},[548,1007,678],{"class":677},[548,1009,682],{"class":681},[548,1011,1012],{"class":685}," Cron",[548,1014,717],{"class":681},[548,1016,1017],{"class":685}," Every",[548,1019,689],{"class":681},[548,1021,692],{"class":677},[548,1023,695],{"class":681},[548,1025,729],{"class":558},[548,1027,701],{"class":681},[548,1029,704],{"class":681},[548,1031,1032,1034,1036,1039,1041,1043,1045,1048,1050],{"class":550,"line":736},[548,1033,678],{"class":677},[548,1035,682],{"class":681},[548,1037,1038],{"class":685}," InvoiceService",[548,1040,689],{"class":681},[548,1042,692],{"class":677},[548,1044,695],{"class":681},[548,1046,1047],{"class":558},"..\u002Fservices\u002FInvoiceService",[548,1049,701],{"class":681},[548,1051,704],{"class":681},[548,1053,1054,1056,1059,1061,1064,1066,1068,1070,1072,1074],{"class":550,"line":759},[548,1055,678],{"class":677},[548,1057,1058],{"class":677}," type",[548,1060,682],{"class":681},[548,1062,1063],{"class":685}," SchedulerTypes",[548,1065,689],{"class":681},[548,1067,692],{"class":677},[548,1069,695],{"class":681},[548,1071,729],{"class":558},[548,1073,701],{"class":681},[548,1075,704],{"class":681},[548,1077,1078],{"class":550,"line":765},[548,1079,762],{"emptyLinePlaceholder":68},[548,1081,1082,1084,1088,1091],{"class":550,"line":783},[548,1083,768],{"class":677},[548,1085,1087],{"class":1086},"spNyl"," class",[548,1089,1090],{"class":554}," BillingJobs",[548,1092,1093],{"class":681}," {\n",[548,1095,1096,1099,1102],{"class":550,"line":796},[548,1097,1098],{"class":681},"  @",[548,1100,1101],{"class":774},"Inject",[548,1103,1104],{"class":685},"(InvoiceService)\n",[548,1106,1107,1110,1113,1116,1118],{"class":550,"line":802},[548,1108,1109],{"class":1086},"  private",[548,1111,1112],{"class":786}," gInvoices",[548,1114,1115],{"class":681},"!:",[548,1117,1038],{"class":554},[548,1119,704],{"class":681},[548,1121,1122],{"class":550,"line":811},[548,1123,762],{"emptyLinePlaceholder":68},[548,1125,1126],{"class":550,"line":817},[548,1127,1129],{"class":1128},"sHwdD","  \u002F\u002F once per day across the whole cluster, on Warsaw wall clock time\n",[548,1131,1132,1134,1137,1139,1141,1144,1146,1148,1150,1153,1155,1157,1160,1162,1164],{"class":550,"line":831},[548,1133,1098],{"class":681},[548,1135,1136],{"class":774},"Cron",[548,1138,777],{"class":685},[548,1140,701],{"class":681},[548,1142,1143],{"class":558},"0 3 * * *",[548,1145,701],{"class":681},[548,1147,717],{"class":681},[548,1149,682],{"class":681},[548,1151,1152],{"class":786}," name",[548,1154,790],{"class":681},[548,1156,695],{"class":681},[548,1158,1159],{"class":558},"billing.close-day",[548,1161,701],{"class":681},[548,1163,689],{"class":681},[548,1165,1166],{"class":685},")\n",[548,1168,1169,1172,1175,1178,1180,1184,1186,1188,1190,1192,1195,1198,1201,1204,1207],{"class":550,"line":843},[548,1170,1171],{"class":1086},"  public",[548,1173,1174],{"class":1086}," async",[548,1176,1177],{"class":786}," closeDay",[548,1179,777],{"class":681},[548,1181,1183],{"class":1182},"sHdIc","ctx",[548,1185,790],{"class":681},[548,1187,1063],{"class":554},[548,1189,861],{"class":681},[548,1191,975],{"class":554},[548,1193,1194],{"class":681},"):",[548,1196,1197],{"class":554}," Promise",[548,1199,1200],{"class":681},"\u003C",[548,1202,1203],{"class":554},"void",[548,1205,1206],{"class":681},">",[548,1208,1093],{"class":681},[548,1210,1211,1214,1217,1220,1223,1226,1229,1232,1235,1237,1240,1243],{"class":550,"line":875},[548,1212,1213],{"class":677},"    for",[548,1215,1216],{"class":786}," (",[548,1218,1219],{"class":1086},"const",[548,1221,1222],{"class":685}," batch",[548,1224,1225],{"class":681}," of",[548,1227,1228],{"class":677}," await",[548,1230,1231],{"class":681}," this.",[548,1233,1234],{"class":685},"gInvoices",[548,1236,861],{"class":681},[548,1238,1239],{"class":774},"openBatches",[548,1241,1242],{"class":786},"()) ",[548,1244,780],{"class":681},[548,1246,1247,1250,1252,1255,1257,1260,1263],{"class":550,"line":886},[548,1248,1249],{"class":685},"      ctx",[548,1251,861],{"class":681},[548,1253,1254],{"class":685},"signal",[548,1256,861],{"class":681},[548,1258,1259],{"class":774},"throwIfAborted",[548,1261,1262],{"class":786},"()",[548,1264,704],{"class":681},[548,1266,1267,1270,1272,1274,1276,1279,1281,1284,1286,1288,1291,1293,1296,1298,1301,1303,1305],{"class":550,"line":911},[548,1268,1269],{"class":677},"      await",[548,1271,1231],{"class":681},[548,1273,1234],{"class":685},[548,1275,861],{"class":681},[548,1277,1278],{"class":774},"close",[548,1280,777],{"class":786},[548,1282,1283],{"class":685},"batch",[548,1285,717],{"class":681},[548,1287,682],{"class":681},[548,1289,1290],{"class":786}," idempotencyKey",[548,1292,790],{"class":681},[548,1294,1295],{"class":685}," ctx",[548,1297,861],{"class":681},[548,1299,1300],{"class":685},"occurrenceId",[548,1302,689],{"class":681},[548,1304,881],{"class":786},[548,1306,704],{"class":681},[548,1308,1309],{"class":550,"line":917},[548,1310,1311],{"class":681},"    }\n",[548,1313,1314],{"class":550,"line":925},[548,1315,1316],{"class":681},"  }\n",[548,1318,1319],{"class":550,"line":933},[548,1320,762],{"emptyLinePlaceholder":68},[548,1322,1324],{"class":550,"line":1323},19,[548,1325,1326],{"class":1128},"  \u002F\u002F every replica clears its own cache\n",[548,1328,1330,1332,1335,1337,1339,1342,1344,1346,1348,1351,1353,1355,1357,1359,1361],{"class":550,"line":1329},20,[548,1331,1098],{"class":681},[548,1333,1334],{"class":774},"Every",[548,1336,777],{"class":685},[548,1338,701],{"class":681},[548,1340,1341],{"class":558},"5m",[548,1343,701],{"class":681},[548,1345,717],{"class":681},[548,1347,682],{"class":681},[548,1349,1350],{"class":786}," scope",[548,1352,790],{"class":681},[548,1354,695],{"class":681},[548,1356,517],{"class":558},[548,1358,701],{"class":681},[548,1360,689],{"class":681},[548,1362,1166],{"class":685},[548,1364,1366,1368,1371,1374,1377],{"class":550,"line":1365},21,[548,1367,1171],{"class":1086},[548,1369,1370],{"class":786}," flushLocalCache",[548,1372,1373],{"class":681},"():",[548,1375,1376],{"class":554}," void",[548,1378,1093],{"class":681},[548,1380,1382,1385,1387,1389,1392,1394],{"class":550,"line":1381},22,[548,1383,1384],{"class":681},"    this.",[548,1386,1234],{"class":685},[548,1388,861],{"class":681},[548,1390,1391],{"class":774},"clearCache",[548,1393,1262],{"class":786},[548,1395,704],{"class":681},[548,1397,1399],{"class":550,"line":1398},23,[548,1400,1316],{"class":681},[548,1402,1404],{"class":550,"line":1403},24,[548,1405,1406],{"class":681},"}\n",[452,1408,1409,1410,1413],{},"A cluster job needs an explicit ",[498,1411,1412],{},"name",". It is part of every lock key, and a name derived from the class could change between builds, since bundlers rename classes whose names collide.",[654,1415,1417],{"id":1416},"bind-the-class","Bind the class",[452,1419,1420],{},"Job classes are ordinary container services. Bind them where you bind your controllers.",[538,1422,1425],{"className":667,"code":1423,"filename":1424,"language":670,"meta":544,"style":544},"import { BillingJobs } from '.\u002Fjobs\u002FBillingJobs';\nimport type { Container } from '@vercube\u002Fdi';\n\nexport function setupContainer(container: Container): void {\n  container.bind(BillingJobs);\n}\n","src\u002Fcontainer.ts",[498,1426,1427,1448,1471,1475,1500,1519],{"__ignoreMap":544},[548,1428,1429,1431,1433,1435,1437,1439,1441,1444,1446],{"class":550,"line":551},[548,1430,678],{"class":677},[548,1432,682],{"class":681},[548,1434,1090],{"class":685},[548,1436,689],{"class":681},[548,1438,692],{"class":677},[548,1440,695],{"class":681},[548,1442,1443],{"class":558},".\u002Fjobs\u002FBillingJobs",[548,1445,701],{"class":681},[548,1447,704],{"class":681},[548,1449,1450,1452,1454,1456,1459,1461,1463,1465,1467,1469],{"class":550,"line":707},[548,1451,678],{"class":677},[548,1453,1058],{"class":677},[548,1455,682],{"class":681},[548,1457,1458],{"class":685}," Container",[548,1460,689],{"class":681},[548,1462,692],{"class":677},[548,1464,695],{"class":681},[548,1466,999],{"class":558},[548,1468,701],{"class":681},[548,1470,704],{"class":681},[548,1472,1473],{"class":550,"line":736},[548,1474,762],{"emptyLinePlaceholder":68},[548,1476,1477,1479,1482,1485,1487,1490,1492,1494,1496,1498],{"class":550,"line":759},[548,1478,768],{"class":677},[548,1480,1481],{"class":1086}," function",[548,1483,1484],{"class":774}," setupContainer",[548,1486,777],{"class":681},[548,1488,1489],{"class":1182},"container",[548,1491,790],{"class":681},[548,1493,1458],{"class":554},[548,1495,1194],{"class":681},[548,1497,1376],{"class":554},[548,1499,1093],{"class":681},[548,1501,1502,1505,1507,1510,1512,1515,1517],{"class":550,"line":765},[548,1503,1504],{"class":685},"  container",[548,1506,861],{"class":681},[548,1508,1509],{"class":774},"bind",[548,1511,777],{"class":786},[548,1513,1514],{"class":685},"BillingJobs",[548,1516,881],{"class":786},[548,1518,704],{"class":681},[548,1520,1521],{"class":550,"line":783},[548,1522,1406],{"class":681},[531,1524,1526],{"id":1525},"health-checks","Health checks",[452,1528,1529,1530,1535,1536,1539,1540,1543,1544,1547,1548,1551],{},"With ",[970,1531,1532],{"href":62},[498,1533,1534],{},"health"," on, the Redis and Postgres stores add a readiness check named ",[498,1537,1538],{},"scheduler:store",". Pass ",[498,1541,1542],{},"health: false"," to ",[498,1545,1546],{},"SchedulerPlugin"," to leave it out, or ",[498,1549,1550],{},"health: { critical: false }"," to report it without failing readiness. The memory store has nothing to check.",[531,1553,1555],{"id":1554},"where-to-go-next","Where to go next",[1557,1558,1559,1565,1570],"ul",{},[1560,1561,1562,1564],"li",{},[970,1563,144],{"href":145},": decorators, every option, the job context, time zones and daylight saving time.",[1560,1566,1567,1569],{},[970,1568,148],{"href":149},": how claims work, the stores, Kubernetes, graceful shutdown, external triggers and queue targets.",[1560,1571,1572,1574,1575,1577],{},[970,1573,109],{"href":152},": the plugin, ",[498,1576,663],{},", the stores, the CLI and testing helpers.",[1579,1580,1581],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .sHdIc, html code.shiki .sHdIc{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#EEFFFF;--shiki-default-font-style:italic;--shiki-dark:#BABED8;--shiki-dark-font-style:italic}",{"title":544,"searchDepth":551,"depth":707,"links":1583},[1584,1585,1586,1587],{"id":533,"depth":707,"text":18},{"id":648,"depth":707,"text":649},{"id":1525,"depth":707,"text":1526},{"id":1554,"depth":707,"text":1555},"Cron and interval jobs for Vercube that run once per occurrence, however many replicas you scale to","md",null,{},{"title":78,"description":1588},"2BEz4U5ypFkCnUFn9LYkn2oRuD-exegpimqxdhq9DtE",[1595,1597],{"title":109,"path":133,"stem":134,"description":1596,"children":-1},"Reference for QueueManager, the queue plugin, decorators, types and errors",{"title":144,"path":145,"stem":146,"description":1598,"children":-1},"Declaring scheduled jobs with @Cron and @Every, their options, the job context, time zones and daylight saving time",1794396675344]