UXP Context

[justintaylor-dev]

From @adamplouff

export const asModal = async (commandName: string, callback: Function) => {
  return await executeAsModal(async (executionContext) => await callback(*executionContext*), { commandName });
};

Pass executionContext to the callback so the user can cancel and get progress updates

[adamplouff]

In use ↓

await asModal('Getting a whole lot of pixels', async (executionContext: ExecutionContext) => {
  let index = 0;
  for (const layer of layers) {
    const layerName = layer.name;
    const layerID = parseInt(layer.id);

    // do some work
    

    index++;
    executionContext.reportProgress({value: index / layers.length});

    if (executionContext.isCancelled) {
      // do some cleanup if needed

      throw "user cancelled +++";
    }
  }
})

Note: The function within the asModal must run it's processes sequentially, rather than a bunch of asyncs in order to be canceled and to update the progress. Looping through a series of layers like a await Promise.all(layers.map(async (layer) => { cannot be canceled mid-process since all of the layer processing must finish before reaching the .isCanceled.