A streaming function that continuously increments the cell value.

Streaming function.EXCEL.yaml

name: Streaming function
description: A streaming function that continuously increments the cell value.
host: EXCEL
api_set: {}
script:
  content: >
    /** @CustomFunction
     * @description Increments the cell with a given amount at a specified interval in milliseconds.
     * @param {number} amount - The amount to add to the cell value on each increment.
     * @param {any} interval - The time in milliseconds to wait before the next increment on the cell.
     * @param {CustomFunctions.StreamingInvocation<any[][]>} invocation - Parameter to send results to Excel
     *     or respond to the user canceling the function.
     * @returns An incrementing value.
     */
    function increment(amount: number, interval: any, invocation:
    CustomFunctions.StreamingInvocation<any[][]>): void {
      var Entity1 = {
        type: "Entity",
        basicType: "Error",
        basicValue: "#VALUE!",
        text: "Entity 1",
        properties: {
          TestDouble: { type: "Double", basicType: "Double", basicValue: 1 },
          TestString: { type: "String", basicType: "String", basicValue: "Test" }
        }
      };
      var Entity2 = {
        type: "Entity",
        basicType: "Error",
        basicValue: "#VALUE!",
        text: "Entity 2",
        properties: {
          TestDouble: { type: "Double", basicType: "Double", basicValue: 2 },
          TestString: { type: "String", basicType: "String", basicValue: "Test" }
        }
      };
      let result = [[Entity1], [Entity2]];
      const timer = setInterval(() => {
        Entity1.properties.TestDouble.basicValue += amount;
        Entity2.properties.TestDouble.basicValue += amount
        invocation.setResult(result);
      }, interval);

      invocation.onCanceled = () => {
        clearInterval(timer);
      };
    }
  language: typescript
libraries: |
  https://appsforoffice.microsoft.com/lib/1/hosted/office.js
  @types/office-js
  core-js@2.4.1/client/core.min.js