Просмотр исходного кода

docs(job-queue-plugin): Add docs on setting prefix

Michael Bromley 9 месяцев назад
Родитель
Сommit
241069b01d
1 измененных файлов с 16 добавлено и 0 удалено
  1. 16 0
      packages/job-queue-plugin/src/bullmq/plugin.ts

+ 16 - 0
packages/job-queue-plugin/src/bullmq/plugin.ts

@@ -169,6 +169,22 @@ import { BullMQPluginOptions } from './types';
  * };
  * ```
  *
+ * ## Setting Redis Prefix
+ *
+ * By default, the underlying BullMQ library will use the default Redis key prefix of `bull`. This can be changed by setting the `prefix` option
+ * in the `queueOptions` and `workerOptions` objects:
+ *
+ * ```ts
+ * BullMQJobQueuePlugin.init({
+ *   workerOptions: {
+ *     prefix: 'my-prefix'
+ *   },
+ *   queueOptions: {
+ *     prefix: 'my-prefix'
+ *   }
+ * }),
+ * ```
+ *
  * @docsCategory core plugins/JobQueuePlugin
  */
 @VendurePlugin({