Skip to content

docs: fix double the typo in definitions.ts #160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jcesarmobile merged 1 commit into from
Jul 20, 2026
Merged

docs: fix double the typo in definitions.ts #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,14 +189,14 @@ On load, Background Runner will automatically register a
background task that will be scheduled and run once your app is
backgrounded.

| Prop | Type | Description | Since |
| --------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| **`label`** | <code>string</code> | The name of the runner, used in logs. | 1.0.0 |
| **`src`** | <code>string</code> | The path to the runner JavaScript file, relative to the app bundle. | 1.0.0 |
| **`event`** | <code>string</code> | The name of the event that will be called when the OS executes the background task. | 1.0.0 |
| **`repeat`** | <code>boolean</code> | If background task should repeat based on the interval set in `interval`. | 1.0.0 |
| **`interval`** | <code>number</code> | The number of minutes after the the app is put into the background in which the background task should begin. If `repeat` is true, this also specifies the number of minutes between each execution. | 1.0.0 |
| **`autoStart`** | <code>boolean</code> | Automatically register and schedule background task on app load. | 1.0.0 |
| Prop | Type | Description | Since |
| --------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
| **`label`** | <code>string</code> | The name of the runner, used in logs. | 1.0.0 |
| **`src`** | <code>string</code> | The path to the runner JavaScript file, relative to the app bundle. | 1.0.0 |
| **`event`** | <code>string</code> | The name of the event that will be called when the OS executes the background task. | 1.0.0 |
| **`repeat`** | <code>boolean</code> | If background task should repeat based on the interval set in `interval`. | 1.0.0 |
| **`interval`** | <code>number</code> | The number of minutes after the app is put into the background in which the background task should begin. If `repeat` is true, this also specifies the number of minutes between each execution. | 1.0.0 |
| **`autoStart`** | <code>boolean</code> | Automatically register and schedule background task on app load. | 1.0.0 |

### Examples

Expand Down
16 changes: 8 additions & 8 deletions packages/capacitor-plugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,14 +189,14 @@ On load, Background Runner will automatically register a
background task that will be scheduled and run once your app is
backgrounded.

| Prop | Type | Description | Since |
| --------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| **`label`** | <code>string</code> | The name of the runner, used in logs. | 1.0.0 |
| **`src`** | <code>string</code> | The path to the runner JavaScript file, relative to the app bundle. | 1.0.0 |
| **`event`** | <code>string</code> | The name of the event that will be called when the OS executes the background task. | 1.0.0 |
| **`repeat`** | <code>boolean</code> | If background task should repeat based on the interval set in `interval`. | 1.0.0 |
| **`interval`** | <code>number</code> | The number of minutes after the the app is put into the background in which the background task should begin. If `repeat` is true, this also specifies the number of minutes between each execution. | 1.0.0 |
| **`autoStart`** | <code>boolean</code> | Automatically register and schedule background task on app load. | 1.0.0 |
| Prop | Type | Description | Since |
| --------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
| **`label`** | <code>string</code> | The name of the runner, used in logs. | 1.0.0 |
| **`src`** | <code>string</code> | The path to the runner JavaScript file, relative to the app bundle. | 1.0.0 |
| **`event`** | <code>string</code> | The name of the event that will be called when the OS executes the background task. | 1.0.0 |
| **`repeat`** | <code>boolean</code> | If background task should repeat based on the interval set in `interval`. | 1.0.0 |
| **`interval`** | <code>number</code> | The number of minutes after the app is put into the background in which the background task should begin. If `repeat` is true, this also specifies the number of minutes between each execution. | 1.0.0 |
| **`autoStart`** | <code>boolean</code> | Automatically register and schedule background task on app load. | 1.0.0 |

### Examples

Expand Down
Binary file modified packages/capacitor-plugin/android/src/main/libs/android-js-engine-release.aar
View file
Open in desktop
Binary file not shown.
4 changes: 2 additions & 2 deletions packages/capacitor-plugin/src/definitions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export interface BackgroundRunnerConfig {
*/
repeat: boolean;
/**
* The number of minutes after the the app is put into the background in which the background task should begin.
* The number of minutes after the app is put into the background in which the background task should begin.
*
* If `repeat` is true, this also specifies the number of minutes between each execution.
*
Expand Down Expand Up @@ -80,7 +80,7 @@ declare module '@capacitor/cli' {
*/
repeat: boolean;
/**
* The number of minutes after the the app is put into the background in which the background task should begin.
* The number of minutes after the app is put into the background in which the background task should begin.
*
* If `repeat` is true, this also specifies the number of minutes between each execution.
*
Expand Down
Loading