Type alias ActionFunction<CustomOptions>

ActionFunction<CustomOptions>: ((input, options, context) => Promise<string | void> | string | void)

An action function is called when the user clicks the action button in PopClip. This is where the extension does its main work.

Type Parameters

CustomOptions = Options

Type declaration

- (input, options, context): Promise<string | void> | string | void
- Parameters
  - input: Input
    The selected text and related properties. (Same object as PopClip.input.)
  - options: CustomOptions & AuthOptions
    Current values of the options for this extension. (Same object as PopClip.options.)
  - context: Context
    Information about the context surrounding the selection. (Same object as PopClip.context.)
  Returns Promise<string | void> | string | void