Home > @i2analyze/notebook-sdk > commands > CommandExecutePayloadMap

commands.CommandExecutePayloadMap type

A mapping of command types to the payload that their commands.ICommandConfig.onExecute() callback receives.

Signature:

type CommandExecutePayloadMap = {
        readonly [TCommandType in CommandType]: CommandPayloadMap[TCommandType] extends void ? ICommandInvocationContext : CommandPayloadMap[TCommandType] & ICommandInvocationContext;
    };

References: CommandType, CommandPayloadMap, ICommandInvocationContext

Introduced: version 1.10

Remarks

This is the command's base payload from commands.CommandPayloadMap combined with the commands.ICommandInvocationContext that describes where and how the command was triggered. Unlike commands.CommandPayloadMap, which also types the onPopulate callback of a dynamic group, this mapping applies only when a command is executed.