Skip to content

Commit

Permalink
GITBOOK-24: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
code-xhyun authored and gitbook-bot committed May 4, 2024
1 parent f85fe86 commit db07322
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
1 change: 1 addition & 0 deletions gitbook/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
* [DefaultLockLimit](docs/setup-and-config/config/defaultlocklimit.md)
* [DefaultLockLifetime](docs/setup-and-config/config/defaultlocklifetime.md)
* [Sort](docs/setup-and-config/config/sort.md)
* [ResumeOnRestart](docs/setup-and-config/config/sort-1.md)
* [Defining Job Processors](docs/defining-job-processors.md)
* [Managing Job Processor](docs/managing-job-processor/README.md)
* [Start](docs/managing-job-processor/start.md)
Expand Down
32 changes: 32 additions & 0 deletions gitbook/docs/setup-and-config/config/sort-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# ResumeOnRestart



## `pulse.resumeOnRestart(resume)`

{% hint style="info" %}
The `resumeOnRestart` method sets a flag to ensure that jobs are resumed if the system restarts. This is particularly important for resuming unfinished jobs that were in progress or awaiting execution prior to the restart.
{% endhint %}

### Example Usage

```typescript
const pulse = new Pulse();

pulse.resumeOnRestart(true)

//kor new Pulse({ resumeOnRestart: true });
```



### Parameters

* **`resume`** (`boolean` - optional): If `true`, enables resuming unfinished jobs after restart. Defaults to `true`.

### Returns

* **`Pulse`**: Returns the instance of the `Pulse` class, enabling method chaining.



0 comments on commit db07322

Please sign in to comment.