diff --git a/src/content/docs/docs/plugin/api.md b/src/content/docs/docs/plugin/api.md index df61d6d0..c76c91a1 100644 --- a/src/content/docs/docs/plugin/api.md +++ b/src/content/docs/docs/plugin/api.md @@ -140,7 +140,7 @@ export default config; * [`reload()`](#reload) * [`setMultiDelay(...)`](#setmultidelay) * [`cancelDelay()`](#canceldelay) -* [`getLatest()`](#getlatest) +* [`getLatest(...)`](#getlatest) * [`setChannel(...)`](#setchannel) * [`unsetChannel(...)`](#unsetchannel) * [`getChannel()`](#getchannel) @@ -389,14 +389,18 @@ Cancels a {@link DelayCondition} to process an upd -------------------- -## getLatest() +## getLatest(...) ```typescript -getLatest() => Promise +getLatest(options?: GetLatestOptions | undefined) => Promise ``` Get Latest bundle available from update Url +| Param | Type | +| ------------- | ------------------------------------------------------------- | +| **`options`** | GetLatestOptions | + **Returns:** Promise<LatestVersion> **Since:** 4.0.0 @@ -871,6 +875,13 @@ Returns null if no next bundle is set. | **`download_url`** | string \| null | +### GetLatestOptions + +| Prop | Type | Description | Default | Since | +| ------------- | ------------------- | ----------------------------------------------------------------------------------------------- | ---------------------- | ----- | +| **`channel`** | string | The channel to get the latest version for The channel must allow 'self_assign' for this to work | undefined | 6.8.0 | + + ### ChannelRes | Prop | Type | Description | Since |