@vendure/docs 0.0.0-202601161541

package/docs/reference/typescript-api/import-export/initial-data.md

@@ -0,0 +1,71 @@
+---
+title: "InitialData"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## InitialData
+
+<GenerationInfo sourceFile="packages/core/src/data-import/types.ts" sourceLine="47" packageName="@vendure/core" />
+
+An object defining initial settings for a new Vendure installation.
+
+```ts title="Signature"
+interface InitialData {
+    defaultLanguage: LanguageCode;
+    defaultZone: string;
+    roles?: RoleDefinition[];
+    countries: CountryDefinition[];
+    taxRates: Array<{ name: string; percentage: number }>;
+    shippingMethods: Array<{ name: string; price: number; taxRate?: number }>;
+    paymentMethods: Array<{ name: string; handler: ConfigurableOperationInput }>;
+    collections: CollectionDefinition[];
+}
+```
+
+<div className="members-wrapper">
+
+### defaultLanguage
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`}   />
+
+
+### defaultZone
+
+<MemberInfo kind="property" type={`string`}   />
+
+
+### roles
+
+<MemberInfo kind="property" type={`RoleDefinition[]`}   />
+
+
+### countries
+
+<MemberInfo kind="property" type={`CountryDefinition[]`}   />
+
+
+### taxRates
+
+<MemberInfo kind="property" type={`Array&#60;{ name: string; percentage: number }&#62;`}   />
+
+
+### shippingMethods
+
+<MemberInfo kind="property" type={`Array&#60;{ name: string; price: number; taxRate?: number }&#62;`}   />
+
+
+### paymentMethods
+
+<MemberInfo kind="property" type={`Array&#60;{ name: string; handler: ConfigurableOperationInput }&#62;`}   />
+
+
+### collections
+
+<MemberInfo kind="property" type={`CollectionDefinition[]`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/import-export/populate.md

@@ -0,0 +1,71 @@
+---
+title: "Populate"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## populate
+
+<GenerationInfo sourceFile="packages/core/src/cli/populate.ts" sourceLine="51" packageName="@vendure/core" />
+
+Populates the Vendure server with some initial data and (optionally) product data from
+a supplied CSV file. The format of the CSV file is described in the section
+[Importing Product Data](/guides/developer-guide/importing-data/).
+
+If the `channelOrToken` argument is provided, all ChannelAware entities (Products, ProductVariants,
+Assets, ShippingMethods, PaymentMethods etc.) will be assigned to the specified Channel.
+The argument can be either a Channel object or a valid channel `token`.
+
+Internally the `populate()` function does the following:
+
+1. Uses the <a href='/reference/typescript-api/import-export/populator#populator'>Populator</a> to populate the <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>.
+2. If `productsCsvPath` is provided, uses <a href='/reference/typescript-api/import-export/importer#importer'>Importer</a> to populate Product data.
+3. Uses <a href='/reference/typescript-api/import-export/populator#populator'>Populator</a> to populate collections specified in the <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>.
+
+*Example*
+
+```ts
+import { bootstrap } from '@vendure/core';
+import { populate } from '@vendure/core/cli';
+import { config } from './vendure-config.ts'
+import { initialData } from './my-initial-data.ts';
+
+const productsCsvFile = path.join(__dirname, 'path/to/products.csv')
+
+populate(
+  () => bootstrap(config),
+  initialData,
+  productsCsvFile,
+)
+.then(app => app.close())
+.then(
+  () => process.exit(0),
+  err => {
+    console.log(err);
+    process.exit(1);
+  },
+);
+```
+
+```ts title="Signature"
+function populate<T extends INestApplicationContext>(bootstrapFn: () => Promise<T | undefined>, initialDataPathOrObject: string | object, productsCsvPath?: string, channelOrToken?: string | import('@vendure/core').Channel): Promise<T>
+```
+Parameters
+
+### bootstrapFn
+
+<MemberInfo kind="parameter" type={`() =&#62; Promise&#60;T | undefined&#62;`} />
+
+### initialDataPathOrObject
+
+<MemberInfo kind="parameter" type={`string | object`} />
+
+### productsCsvPath
+
+<MemberInfo kind="parameter" type={`string`} />
+
+### channelOrToken
+
+<MemberInfo kind="parameter" type={`string | import('@vendure/core').<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`} />
+

package/docs/reference/typescript-api/import-export/populator.md

@@ -0,0 +1,38 @@
+---
+title: "Populator"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## Populator
+
+<GenerationInfo sourceFile="packages/core/src/data-import/providers/populator/populator.ts" sourceLine="46" packageName="@vendure/core" />
+
+Responsible for populating the database with <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>, i.e. non-product data such as countries, tax rates,
+shipping methods, payment methods & roles.
+
+```ts title="Signature"
+class Populator {
+    populateInitialData(data: InitialData, channel?: Channel) => ;
+    populateCollections(data: InitialData, channel?: Channel) => ;
+}
+```
+
+<div className="members-wrapper">
+
+### populateInitialData
+
+<MemberInfo kind="method" type={`(data: <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>, channel?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>) => `}   />
+
+Should be run *before* populating the products, so that there are TaxRates by which
+product prices can be set. If the `channel` argument is set, then any <a href='/reference/typescript-api/entities/interfaces#channelaware'>ChannelAware</a>entities will be assigned to that Channel.
+### populateCollections
+
+<MemberInfo kind="method" type={`(data: <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>, channel?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>) => `}   />
+
+Should be run *after* the products have been populated, otherwise the expected FacetValues will not
+yet exist.
+
+
+</div>

package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.md

@@ -0,0 +1,245 @@
+---
+title: "DefaultJobQueuePlugin"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## DefaultJobQueuePlugin
+
+<GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/default-job-queue-plugin.ts" sourceLine="127" packageName="@vendure/core" />
+
+A plugin which configures Vendure to use the SQL database to persist the JobQueue jobs using the <a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a>. If you add this
+plugin to an existing Vendure installation, you'll need to run a [database migration](/guides/developer-guide/migrations), since this
+plugin will add a new "job_record" table to the database.
+
+*Example*
+
+```ts
+import { DefaultJobQueuePlugin, VendureConfig } from '@vendure/core';
+
+export const config: VendureConfig = {
+  // Add an instance of the plugin to the plugins array
+  plugins: [
+    DefaultJobQueuePlugin,
+  ],
+};
+```
+
+## Configuration
+
+It is possible to configure the behaviour of the <a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a> by passing options to the static `init()` function:
+
+### pollInterval
+The interval in ms between polling for new jobs. The default is 200ms.
+Using a longer interval reduces load on the database but results in a slight
+delay in processing jobs. For more control, it is possible to supply a function which can specify
+a pollInterval based on the queue name:
+
+*Example*
+
+```ts
+export const config: VendureConfig = {
+  plugins: [
+    DefaultJobQueuePlugin.init({
+      pollInterval: queueName => {
+        if (queueName === 'cart-recovery-email') {
+          // This queue does not need to be polled so frequently,
+          // so we set a longer interval in order to reduce load
+          // on the database.
+          return 10000;
+        }
+        return 200;
+      },
+    }),
+  ],
+};
+```
+### concurrency
+The number of jobs to process concurrently per worker. Defaults to 1.
+
+### backoffStrategy
+Defines the backoff strategy used when retrying failed jobs. In other words, if a job fails
+and is configured to be re-tried, how long should we wait before the next attempt?
+
+By default, a job will be retried as soon as possible, but in some cases this is not desirable. For example,
+a job may interact with an unreliable 3rd-party API which is sensitive to too many requests. In this case, an
+exponential backoff may be used which progressively increases the delay between each subsequent retry.
+
+*Example*
+
+```ts
+export const config: VendureConfig = {
+  plugins: [
+    DefaultJobQueuePlugin.init({
+      pollInterval: 5000,
+      concurrency: 2
+      backoffStrategy: (queueName, attemptsMade, job) => {
+        if (queueName === 'transcode-video') {
+          // exponential backoff example
+          return (attemptsMade ** 2) * 1000;
+        }
+
+        // A default delay for all other queues
+        return 1000;
+      },
+      setRetries: (queueName, job) => {
+        if (queueName === 'send-email') {
+          // Override the default number of retries
+          // for the 'send-email' job because we have
+          // a very unreliable email service.
+          return 10;
+        }
+        return job.retries;
+      }
+    }),
+  ],
+};
+```
+
+### Removing old jobs
+Since v3.3, the job queue will automatically remove old jobs from the database. This is done by a scheduled task
+which runs every 2 hours by default. The number of jobs to keep in the database can be configured using the
+`keepJobsCount` option. The default is 1000.
+
+*Example*
+
+```ts
+export const config: VendureConfig = {
+  plugins: [
+    DefaultJobQueuePlugin.init({
+      // The number of completed/failed/cancelled
+      // jobs to keep in the database. The default is 1000.
+      keepJobsCount: 100,
+      // The interval at which to run the clean-up task.
+      // This can be a standard cron expression or a function
+      // that returns a cron expression. The default is every 2 hours.
+      cleanJobsSchedule: cron => cron.every(5).hours(),
+    }),
+  ],
+};
+```
+
+```ts title="Signature"
+class DefaultJobQueuePlugin {
+    init(options: DefaultJobQueueOptions) => Type<DefaultJobQueuePlugin>;
+}
+```
+
+<div className="members-wrapper">
+
+### init
+
+<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueoptions'>DefaultJobQueueOptions</a>) => Type&#60;<a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a>&#62;`}   />
+
+
+
+
+</div>
+
+
+## cleanJobsTask
+
+<GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/clean-jobs-task.ts" sourceLine="18" packageName="@vendure/core" since="3.3.0" />
+
+A <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a> that cleans up old jobs from the database when using the DefaultJobQueuePlugin.
+You can configure the settings & schedule of the task via the <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a> options.
+
+
+
+## DefaultJobQueueOptions
+
+<GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/types.ts" sourceLine="12" packageName="@vendure/core" />
+
+Configuration options for the DefaultJobQueuePlugin. These values get passed into the
+<a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a>.
+
+```ts title="Signature"
+interface DefaultJobQueueOptions {
+    pollInterval?: number | ((queueName: string) => number);
+    concurrency?: number;
+    backoffStrategy?: BackoffStrategy;
+    setRetries?: (queueName: string, job: Job) => number;
+    useDatabaseForBuffer?: boolean;
+    gracefulShutdownTimeout?: number;
+    keepJobsCount?: number;
+    cleanJobsSchedule?: ScheduledTaskConfig['schedule'];
+}
+```
+
+<div className="members-wrapper">
+
+### pollInterval
+
+<MemberInfo kind="property" type={`number | ((queueName: string) =&#62; number)`} default={`200`}   />
+
+The interval in ms between polling the database for new jobs. If many job queues
+are active, the polling may cause undue load on the database, in which case this value
+should be increased to e.g. 1000.
+### concurrency
+
+<MemberInfo kind="property" type={`number`} default={`1`}   />
+
+How many jobs from a given queue to process concurrently.
+### backoffStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/job-queue/types#backoffstrategy'>BackoffStrategy</a>`} default={`() =&#62; 1000`}   />
+
+The strategy used to decide how long to wait before retrying a failed job.
+### setRetries
+
+<MemberInfo kind="property" type={`(queueName: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) =&#62; number`}   />
+
+When a job is added to the JobQueue using `JobQueue.add()`, the calling
+code may specify the number of retries in case of failure. This option allows
+you to override that number and specify your own number of retries based on
+the job being added.
+
+*Example*
+
+```ts
+setRetries: (queueName, job) => {
+  if (queueName === 'send-email') {
+    // Override the default number of retries
+    // for the 'send-email' job because we have
+    // a very unreliable email service.
+    return 10;
+  }
+  return job.retries;
+}
+ ```
+### useDatabaseForBuffer
+
+<MemberInfo kind="property" type={`boolean`}  since="1.3.0"  />
+
+If set to `true`, the database will be used to store buffered jobs. This is
+recommended for production.
+
+When enabled, a new `JobRecordBuffer` database entity will be defined which will
+require a migration when first enabling this option.
+### gracefulShutdownTimeout
+
+<MemberInfo kind="property" type={`number`} default={`20_000`}  since="2.2.0"  />
+
+The timeout in ms which the queue will use when attempting a graceful shutdown.
+That means when the server is shut down but a job is running, the job queue will
+wait for the job to complete before allowing the server to shut down. If the job
+does not complete within this timeout window, the job will be forced to stop
+and the server will shut down anyway.
+### keepJobsCount
+
+<MemberInfo kind="property" type={`number`} default={`1000`}  since="3.3.0"  />
+
+The number of completed/failed jobs to keep in the database. This is useful for
+debugging and auditing purposes, but if you have a lot of jobs, it may be
+desirable to limit the number of records in the database.
+### cleanJobsSchedule
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtaskconfig'>ScheduledTaskConfig</a>['schedule']`} default={`cron =&#62; cron.every(2).hours()`}  since="3.3.0"  />
+
+The schedule for the "clean-jobs" task. This task will run periodically to clean up
+old jobs from the database. The schedule can be a cron expression or a function
+that returns a cron expression.
+
+
+</div>

package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.md

@@ -0,0 +1,55 @@
+---
+title: "InMemoryJobBufferStorageStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## InMemoryJobBufferStorageStrategy
+
+<GenerationInfo sourceFile="packages/core/src/job-queue/job-buffer/in-memory-job-buffer-storage-strategy.ts" sourceLine="17" packageName="@vendure/core" since="1.3.0" />
+
+A <a href='/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy'>JobBufferStorageStrategy</a> which keeps the buffered jobs in memory. Should
+_not_ be used in production, since it will lose data in the event of the server
+stopping.
+
+Instead, use the <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a> with the `useDatabaseForBuffer: true` option set,
+or the <a href='/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin'>BullMQJobQueuePlugin</a> or another custom strategy with persistent storage.
+
+```ts title="Signature"
+class InMemoryJobBufferStorageStrategy implements JobBufferStorageStrategy {
+    protected bufferStorage = new Map<string, Set<Job>>();
+    add(bufferId: string, job: Job) => Promise<Job>;
+    bufferSize(bufferIds?: string[]) => Promise<{ [bufferId: string]: number }>;
+    flush(bufferIds?: string[]) => Promise<{ [bufferId: string]: Job[] }>;
+}
+```
+* Implements: <code><a href='/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy'>JobBufferStorageStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### bufferStorage
+
+<MemberInfo kind="property" type={``}   />
+
+
+### add
+
+<MemberInfo kind="method" type={`(bufferId: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#62;`}   />
+
+
+### bufferSize
+
+<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise&#60;{ [bufferId: string]: number }&#62;`}   />
+
+
+### flush
+
+<MemberInfo kind="method" type={`(bufferIds?: string[]) => Promise&#60;{ [bufferId: string]: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>[] }&#62;`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.md

@@ -0,0 +1,110 @@
+---
+title: "InMemoryJobQueueStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## InMemoryJobQueueStrategy
+
+<GenerationInfo sourceFile="packages/core/src/job-queue/in-memory-job-queue-strategy.ts" sourceLine="42" packageName="@vendure/core" />
+
+An in-memory <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a>. This is the default strategy if not using a dedicated
+JobQueue plugin (e.g. <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a>). Not recommended for production, since
+the queue will be cleared when the server stops, and can only be used when the JobQueueService is
+started from the main server process:
+
+*Example*
+
+```ts
+bootstrap(config)
+  .then(app => app.get(JobQueueService).start());
+```
+
+Attempting to use this strategy when running the worker in a separate process (using `bootstrapWorker()`)
+will result in an error on startup.
+
+Completed jobs will be evicted from the store every 2 hours to prevent a memory leak.
+
+```ts title="Signature"
+class InMemoryJobQueueStrategy extends PollingJobQueueStrategy implements InspectableJobQueueStrategy {
+    protected jobs = new Map<ID, Job>();
+    protected unsettledJobs: { [queueName: string]: Array<{ job: Job; updatedAt: Date }> } = {};
+    init(injector: Injector) => ;
+    destroy() => ;
+    add(job: Job<Data>) => Promise<Job<Data>>;
+    findOne(id: ID) => Promise<Job | undefined>;
+    findMany(options?: JobListOptions) => Promise<PaginatedList<Job>>;
+    findManyById(ids: ID[]) => Promise<Job[]>;
+    next(queueName: string, waitingJobs: Job[] = []) => Promise<Job | undefined>;
+    update(job: Job) => Promise<void>;
+    removeSettledJobs(queueNames: string[] = [], olderThan?: Date) => Promise<number>;
+}
+```
+* Extends: <code><a href='/reference/typescript-api/job-queue/polling-job-queue-strategy#pollingjobqueuestrategy'>PollingJobQueueStrategy</a></code>
+
+
+* Implements: <code><a href='/reference/typescript-api/job-queue/inspectable-job-queue-strategy#inspectablejobqueuestrategy'>InspectableJobQueueStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### jobs
+
+<MemberInfo kind="property" type={``}   />
+
+
+### unsettledJobs
+
+<MemberInfo kind="property" type={`{ [queueName: string]: Array&#60;{ job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>; updatedAt: Date }&#62; }`}   />
+
+
+### init
+
+<MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>) => `}   />
+
+
+### destroy
+
+<MemberInfo kind="method" type={`() => `}   />
+
+
+### add
+
+<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#60;Data&#62;&#62;`}   />
+
+
+### findOne
+
+<MemberInfo kind="method" type={`(id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined&#62;`}   />
+
+
+### findMany
+
+<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise&#60;<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>&#62;&#62;`}   />
+
+
+### findManyById
+
+<MemberInfo kind="method" type={`(ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a>[]&#62;`}   />
+
+
+### next
+
+<MemberInfo kind="method" type={`(queueName: string, waitingJobs: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>[] = []) => Promise&#60;<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined&#62;`}   />
+
+
+### update
+
+<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => Promise&#60;void&#62;`}   />
+
+
+### removeSettledJobs
+
+<MemberInfo kind="method" type={`(queueNames: string[] = [], olderThan?: Date) => Promise&#60;number&#62;`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/job-queue/index.md

@@ -0,0 +1,84 @@
+---
+title: "JobQueue"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## JobQueue
+
+<GenerationInfo sourceFile="packages/core/src/job-queue/job-queue.ts" sourceLine="21" packageName="@vendure/core" />
+
+A JobQueue is used to process <a href='/reference/typescript-api/job-queue/job#job'>Job</a>s. A job is added to the queue via the
+`.add()` method, and the configured <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> will check for new jobs and process each
+according to the defined `process` function.
+
+*Note*: JobQueue instances should not be directly instantiated. Rather, the
+<a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a> `createQueue()` method should be used (see that service
+for example usage).
+
+```ts title="Signature"
+class JobQueue<Data extends JobData<Data> = object> {
+    name: string
+    started: boolean
+    constructor(options: CreateQueueOptions<Data>, jobQueueStrategy: JobQueueStrategy, jobBufferService: JobBufferService)
+    add(data: Data, options?: JobOptions<Data>) => Promise<SubscribableJob<Data>>;
+}
+```
+
+<div className="members-wrapper">
+
+### name
+
+<MemberInfo kind="property" type={`string`}   />
+
+
+### started
+
+<MemberInfo kind="property" type={`boolean`}   />
+
+
+### constructor
+
+<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/types#createqueueoptions'>CreateQueueOptions</a>&#60;Data&#62;, jobQueueStrategy: <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a>, jobBufferService: JobBufferService) => JobQueue`}   />
+
+
+### add
+
+<MemberInfo kind="method" type={`(data: Data, options?: JobOptions&#60;Data&#62;) => Promise&#60;<a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a>&#60;Data&#62;&#62;`}   />
+
+Adds a new <a href='/reference/typescript-api/job-queue/job#job'>Job</a> to the queue. The resolved <a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a> allows the
+calling code to subscribe to updates to the Job:
+
+*Example*
+
+```ts
+const job = await this.myQueue.add({ intervalMs, shouldFail }, { retries: 2 });
+return job.updates().pipe(
+  map(update => {
+    // The returned Observable will emit a value for every update to the job
+    // such as when the `progress` or `status` value changes.
+    Logger.info(`Job ${update.id}: progress: ${update.progress}`);
+    if (update.state === JobState.COMPLETED) {
+      Logger.info(`COMPLETED ${update.id}: ${update.result}`);
+    }
+    return update.result;
+  }),
+  catchError(err => of(err.message)),
+);
+```
+
+Alternatively, if you aren't interested in the intermediate
+`progress` changes, you can convert to a Promise like this:
+
+*Example*
+
+```ts
+const job = await this.myQueue.add({ intervalMs, shouldFail }, { retries: 2 });
+return job.updates().toPromise()
+  .then(update => update.result),
+  .catch(err => err.message);
+```
+
+
+</div>