@scm-js/plugin-api 1.7.0 → 1.8.0

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/index.d.ts +12 -4
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -3951,14 +3951,22 @@ export interface StatusLineOptions extends WidgetOptions {
3951
3951
  * download: the bar's own movement is not announced).
3952
3952
  */
3953
3953
  export type StatusLineElement = HTMLElement & {
3954
- /** A finished line. `kind` colours it; nothing means plain. */
3955
- set(text: string, kind?: "ok" | "warn" | "error"): void;
3954
+ /**
3955
+ * A finished line. `kind` colours it; nothing means plain. A `Node` in place of the
3956
+ * text is for a line that carries more than words — a failure with a link to the
3957
+ * settings that would fix it.
3958
+ */
3959
+ set(text: string | Node, kind?: "ok" | "warn" | "error"): void;
3956
3960
  /** Waiting, with no idea how long: a ring and the text. */
3957
3961
  busy(text: string): void;
3958
3962
  /** Waiting with a share done (0…1), or null for the sliding bar. */
3959
3963
  progress(text: string, value: number | null): void;
3960
- /** A Cancel beside the line that calls `stop`; null takes it away. */
3961
- cancel(stop: (() => void) | null): void;
3964
+ /**
3965
+ * A Cancel beside the line that calls `stop`; null takes it away. `label` is the
3966
+ * button's word — "Stop" for a request that is running, since Cancel in a dialog
3967
+ * means leaving it.
3968
+ */
3969
+ cancel(stop: (() => void) | null, label?: string): void;
3962
3970
  /** Back to an empty line. */
3963
3971
  clear(): void;
3964
3972
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scm-js/plugin-api",
3
- "version": "1.7.0",
3
+ "version": "1.8.0",
4
4
  "description": "Type declarations for the scmJS plugin API",
5
5
  "license": "MIT",
6
6
  "types": "index.d.ts",