chore(release): 1.25.0 [skip ci]

# [1.25.0](v1.24.5...v1.25.0) (2021-05-11)

### Features

* **job:** add sizeLimit option when creating a job ([f10aeeb](f10aeeb))

docs/gitbook/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.25.0](https://github.com/taskforcesh/bullmq/compare/v1.24.5...v1.25.0) (2021-05-11)
+
+
+### Features
+
+* **job:** add sizeLimit option when creating a job ([f10aeeb](https://github.com/taskforcesh/bullmq/commit/f10aeeb62520d20b31d35440524d147ac4adcc9c))
+
 ## [1.24.5](https://github.com/taskforcesh/bullmq/compare/v1.24.4...v1.24.5) (2021-05-08)
 
 

docs/gitbook/api/bullmq.job.attemptsmade.md

@@ -4,6 +4,8 @@
 
 ## Job.attemptsMade property
 
+Number of attempts after the job has failed.
+
 <b>Signature:</b>
 
 ```typescript

docs/gitbook/api/bullmq.job.failedreason.md

@@ -4,6 +4,8 @@
 
 ## Job.failedReason property
 
+Reason for failing.
+
 <b>Signature:</b>
 
 ```typescript

docs/gitbook/api/bullmq.job.finishedon.md

@@ -4,6 +4,8 @@
 
 ## Job.finishedOn property
 
+Timestamp for when the job finished (completed or failed).
+
 <b>Signature:</b>
 
 ```typescript

docs/gitbook/api/bullmq.job.md

@@ -20,19 +20,19 @@ export declare class Job<T = any, R = any, N extends string = string>
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [attemptsMade](./bullmq.job.attemptsmade.md) |  | number |  |
+|  [attemptsMade](./bullmq.job.attemptsmade.md) |  | number | Number of attempts after the job has failed. |
 |  [data](./bullmq.job.data.md) |  | T |  |
-|  [failedReason](./bullmq.job.failedreason.md) |  | string |  |
-|  [finishedOn?](./bullmq.job.finishedon.md) |  | number | <i>(Optional)</i> |
+|  [failedReason](./bullmq.job.failedreason.md) |  | string | Reason for failing. |
+|  [finishedOn?](./bullmq.job.finishedon.md) |  | number | <i>(Optional)</i> Timestamp for when the job finished (completed or failed). |
 |  [id?](./bullmq.job.id.md) |  | string | <i>(Optional)</i> |
 |  [name](./bullmq.job.name.md) |  | N |  |
 |  [opts](./bullmq.job.opts.md) |  | [JobsOptions](./bullmq.jobsoptions.md) |  |
-|  [parentKey?](./bullmq.job.parentkey.md) |  | string | <i>(Optional)</i> Fully qualified key pointing to the parent of this job. |
-|  [processedOn?](./bullmq.job.processedon.md) |  | number | <i>(Optional)</i> |
-|  [progress](./bullmq.job.progress.md) |  | number \| object |  |
-|  [returnvalue](./bullmq.job.returnvalue.md) |  | R |  |
-|  [stacktrace](./bullmq.job.stacktrace.md) |  | string\[\] |  |
-|  [timestamp](./bullmq.job.timestamp.md) |  | number |  |
+|  [parentKey?](./bullmq.job.parentkey.md) |  | string | <i>(Optional)</i> Fully qualified key (including the queue prefix) pointing to the parent of this job. |
+|  [processedOn?](./bullmq.job.processedon.md) |  | number | <i>(Optional)</i> Timestamp for when the job was processed. |
+|  [progress](./bullmq.job.progress.md) |  | number \| object | The progress a job has performed so far. |
+|  [returnvalue](./bullmq.job.returnvalue.md) |  | R | The value returned by the processor when processing this job. |
+|  [stacktrace](./bullmq.job.stacktrace.md) |  | string\[\] | Stacktrace for the error (for failed jobs). |
+|  [timestamp](./bullmq.job.timestamp.md) |  | number | Timestamp when the job was created (unless overrided with job options). |
 
 ## Methods
 

docs/gitbook/api/bullmq.job.parentkey.md

@@ -4,7 +4,7 @@
 
 ## Job.parentKey property
 
-Fully qualified key pointing to the parent of this job.
+Fully qualified key (including the queue prefix) pointing to the parent of this job.
 
 <b>Signature:</b>
 

docs/gitbook/api/bullmq.job.processedon.md

@@ -4,6 +4,8 @@
 
 ## Job.processedOn property
 
+Timestamp for when the job was processed.
+
 <b>Signature:</b>
 
 ```typescript

docs/gitbook/api/bullmq.job.progress.md

@@ -4,6 +4,8 @@
 
 ## Job.progress property
 
+The progress a job has performed so far.
+
 <b>Signature:</b>
 
 ```typescript

docs/gitbook/api/bullmq.job.returnvalue.md

@@ -4,6 +4,8 @@
 
 ## Job.returnvalue property
 
+The value returned by the processor when processing this job.
+
 <b>Signature:</b>
 
 ```typescript

docs/gitbook/api/bullmq.job.stacktrace.md

@@ -4,6 +4,8 @@
 
 ## Job.stacktrace property
 
+Stacktrace for the error (for failed jobs).
+
 <b>Signature:</b>
 
 ```typescript

docs/gitbook/api/bullmq.job.timestamp.md

@@ -4,6 +4,8 @@
 
 ## Job.timestamp property
 
+Timestamp when the job was created (unless overrided with job options).
+
 <b>Signature:</b>
 
 ```typescript

docs/gitbook/api/bullmq.jobsoptions.md

@@ -26,7 +26,8 @@ export interface JobsOptions
 |  [removeOnComplete?](./bullmq.jobsoptions.removeoncomplete.md) | boolean \| number | <i>(Optional)</i> If true, removes the job when it successfully completes When given an number, it specifies the maximum amount of jobs to keep. Default behavior is to keep the job in the completed set. |
 |  [removeOnFail?](./bullmq.jobsoptions.removeonfail.md) | boolean \| number | <i>(Optional)</i> If true, removes the job when it fails after all attempts. When given an number, it specifies the maximum amount of jobs to keep. |
 |  [repeat?](./bullmq.jobsoptions.repeat.md) | [RepeatOptions](./bullmq.repeatoptions.md) | <i>(Optional)</i> Repeat this job, for example based on a <code>cron</code> schedule. |
+|  [sizeLimit?](./bullmq.jobsoptions.sizelimit.md) | number | <i>(Optional)</i> Limits the size in bytes of the job's data payload (as a JSON serialized string). |
 |  [stackTraceLimit?](./bullmq.jobsoptions.stacktracelimit.md) | number | <i>(Optional)</i> Limits the amount of stack trace lines that will be recorded in the stacktrace. |
 |  [timeout?](./bullmq.jobsoptions.timeout.md) | number | <i>(Optional)</i> The number of milliseconds after which the job should be fail with a timeout error. |
-|  [timestamp?](./bullmq.jobsoptions.timestamp.md) | number | <i>(Optional)</i> Defaults to <code>Date.now()</code> |
+|  [timestamp?](./bullmq.jobsoptions.timestamp.md) | number | <i>(Optional)</i> Timestamp when the job was created. Defaults to <code>Date.now()</code>. |
 

docs/gitbook/api/bullmq.jobsoptions.sizelimit.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bullmq](./bullmq.md) &gt; [JobsOptions](./bullmq.jobsoptions.md) &gt; [sizeLimit](./bullmq.jobsoptions.sizelimit.md)
+
+## JobsOptions.sizeLimit property
+
+Limits the size in bytes of the job's data payload (as a JSON serialized string).
+
+<b>Signature:</b>
+
+```typescript
+sizeLimit?: number;
+```

docs/gitbook/api/bullmq.jobsoptions.timestamp.md

@@ -4,7 +4,7 @@
 
 ## JobsOptions.timestamp property
 
-Defaults to `Date.now()`
+Timestamp when the job was created. Defaults to `Date.now()`<!-- -->.
 
 <b>Signature:</b>
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bullmq",
-  "version": "1.24.5",
+  "version": "1.25.0",
   "description": "Queue for messages and jobs based on Redis",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",