@theia/plugin 1.25.0-next.1 → 1.25.0-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +2 -2
  2. package/src/theia.d.ts +26 -19
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theia/plugin",
3
- "version": "1.25.0-next.1+bd604c313d2",
3
+ "version": "1.25.0-next.2+ce495c5fb38",
4
4
  "description": "Theia - Plugin API",
5
5
  "types": "./src/theia.d.ts",
6
6
  "publishConfig": {
@@ -32,5 +32,5 @@
32
32
  "nyc": {
33
33
  "extends": "../../configs/nyc.json"
34
34
  },
35
- "gitHead": "bd604c313d2f2c15bb7f5cf1b21222fbe0a46f6d"
35
+ "gitHead": "ce495c5fb3845dd48ccb525e43fdf24a34d04a16"
36
36
  }
package/src/theia.d.ts CHANGED
@@ -4211,36 +4211,43 @@ export module '@theia/plugin' {
4211
4211
 
4212
4212
  /**
4213
4213
  * Shows a selection list.
4214
- * @param items
4215
- * @param options
4216
- * @param token
4214
+ *
4215
+ * @param items An array of strings, or a promise that resolves to an array of strings.
4216
+ * @param options Configures the behavior of the selection list.
4217
+ * @param token A token that can be used to signal cancellation.
4218
+ * @return A promise that resolves to the selection or `undefined`.
4217
4219
  */
4218
- export function showQuickPick(items: string[] | PromiseLike<string[]>, options: QuickPickOptions, token?: CancellationToken): PromiseLike<string | undefined>;
4220
+ export function showQuickPick(readonly items: string[] | PromiseLike<readonly string[]>, options: QuickPickOptions, token?: CancellationToken): PromiseLike<string | undefined>;
4219
4221
 
4220
4222
  /**
4221
- * Shows a selection list with multiple selection allowed.
4223
+ * Shows a selection list allowing multiple selections.
4224
+ *
4225
+ * @param items An array of strings, or a promise that resolves to an array of strings.
4226
+ * @param options Configures the behavior of the selection list.
4227
+ * @param token A token that can be used to signal cancellation.
4228
+ * @return A promise that resolves to the selected items or `undefined`.
4222
4229
  */
4223
- export function showQuickPick(
4224
- items: string[] | PromiseLike<string[]>,
4225
- options: QuickPickOptions & { canPickMany: true },
4226
- token?: CancellationToken
4227
- ): PromiseLike<string[] | undefined>;
4230
+ export function showQuickPick(readonly items: string[] | PromiseLike<readonly string[]>, options: QuickPickOptions & { canPickMany: true }, token?: CancellationToken): PromiseLike<string[] | undefined>;
4228
4231
 
4229
4232
  /**
4230
4233
  * Shows a selection list.
4231
- * @param items
4232
- * @param options
4233
- * @param token
4234
+ *
4235
+ * @param items An array of items, or a promise that resolves to an array of items.
4236
+ * @param options Configures the behavior of the selection list.
4237
+ * @param token A token that can be used to signal cancellation.
4238
+ * @return A promise that resolves to the selected item or `undefined`.
4234
4239
  */
4235
- export function showQuickPick<T extends QuickPickItem>(items: T[] | PromiseLike<T[]>, options: QuickPickOptions, token?: CancellationToken): PromiseLike<T | undefined>;
4240
+ export function showQuickPick<T extends QuickPickItem>(items: readonly T[] | PromiseLike<readonly T[]>, options: QuickPickOptions, token?: CancellationToken): PromiseLike<T | undefined>;
4236
4241
 
4237
4242
  /**
4238
- * Shows a selection list with multiple selection allowed.
4243
+ * Shows a selection list allowing multiple selections.
4244
+ *
4245
+ * @param items An array of items, or a promise that resolves to an array of items.
4246
+ * @param options Configures the behavior of the selection list.
4247
+ * @param token A token that can be used to signal cancellation.
4248
+ * @return A promise that resolves to the selected items or `undefined`.
4239
4249
  */
4240
- export function showQuickPick<T extends QuickPickItem>(items: T[] | PromiseLike<T[]>,
4241
- options: QuickPickOptions & { canPickMany: true },
4242
- token?: CancellationToken
4243
- ): PromiseLike<T[] | undefined>;
4250
+ export function showQuickPick<T extends QuickPickItem>(items: readonly T[] | PromiseLike<readonly T[]>, options: QuickPickOptions & { canPickMany: true }, token?: CancellationToken): PromiseLike<T[] | undefined>;
4244
4251
 
4245
4252
  /**
4246
4253
  * Creates a [QuickPick](#QuickPick) to let the user pick an item from a list