refactor: deprecate job queue depth property (#14402)

AlessioGr · web-flow · commit 1341f69e074e · 2025-10-29T17:42:46.000Z
Similar to how we deprecated the `runHooks` property in #13617, this PR deprecates the `depth` property. Just like `runHooks`, setting depth to 1 or higher will massively slow down the job system and make it less reliable. It's also adds a lot of unnecessary code we will need to maintain. To further discourage using this property, this PR marks it as deprecated and for removal in 4.0.
diff --git a/packages/payload/src/queues/config/types/index.ts b/packages/payload/src/queues/config/types/index.ts
@@ -127,6 +127,7 @@ export type JobsConfig = {
    * queries will be used.
    *
    * @default 0
+   * @deprecated - this will be removed in 4.0
    */
   depth?: number
   /**

Original file line number	Diff line number	Diff line change
`@@ -127,6 +127,7 @@ export type JobsConfig = {`
`127`	`127`	`* queries will be used.`
`128`	`128`	`*`
`129`	`129`	`* @default 0`
	`130`	`+ * @deprecated - this will be removed in 4.0`
`130`	`131`	`*/`
`131`	`132`	`depth?: number`
`132`	`133`	`/**`