Edit

Share via

CustomFunctions.CancelableInvocation interface

  • Reference
Package:
custom-functions-runtime

Provides information about the invocation of a cancelable custom function. A cancelable custom function can provide a handler for the onCanceled event.

To indicate that a function is cancelable, in the metadata JSON file, the function options should specify: { "cancelable": true }

If the metadata JSON file is being generated from JSDoc comments, include the tag @cancelable.

Extends
CustomFunctions.Invocation

Events

onCanceled

Event handler called when the custom function is canceled.

Event Details

onCanceled

Event handler called when the custom function is canceled.

onCanceled?: () => void;

Event Type

() => void

Remarks

[ API set: CustomFunctionsRuntime 1.1 ]