EditorEvent

type EditorEvent =
  | {
  fileName: string;
  ms: number;
  sheets: number;
  type: "opened";
}
  | {
  fileName: string;
  reason: string;
  type: "openFailed";
}
  | {
  formulas: number;
  live: number;
  ms: number;
  notCalculated: number;
  type: "calculated";
}
  | {
  editedCount: number;
  ms: number;
  result: SaveResult;
  type: "saved";
}
  | {
  message: string;
  type: "error";
}
  | {
  message: string;
  plugin: string;
  type: "pluginError";
}
  | {
  ms: number;
  name: string;
  source: string;
  type: "savedToSource";
};

What the editor tells onEvent. Messages are in English, whatever the editor’s language, so logs read the same.

Union Members

Type Literal

{
  fileName: string;
  ms: number;
  sheets: number;
  type: "opened";
}

---

Type Literal

{
  fileName: string;
  reason: string;
  type: "openFailed";
}

---

Type Literal

{
  formulas: number;
  live: number;
  ms: number;
  notCalculated: number;
  type: "calculated";
}

The calculation engine is built (or live recalculation is off): how many formulas it keeps up to date.

---

Type Literal

{
  editedCount: number;
  ms: number;
  result: SaveResult;
  type: "saved";
}

---

Type Literal

{
  message: string;
  type: "error";
}

An error the editor showed the user.

---

Type Literal

{
  message: string;
  plugin: string;
  type: "pluginError";
}

A plugin threw, or was refused; it is named by its id (empty when it has none).

---

Type Literal

{
  ms: number;
  name: string;
  source: string;
  type: "savedToSource";
}

The workbook was written to a plugin’s file source: saved back over its file, or as a copy.