-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f85fe86
commit db07322
Showing
2 changed files
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|
||
|