Type Alias cmdFuncOut

cmdFuncOut: (
    eventData: ccArg,
) =>
    | CustomCommandResult
    | undefined
    | Promise<CustomCommandResult>
    | Promise<undefined>

represents a command function that can be executed.

Type declaration

- (
      eventData: ccArg,
  ):
      | CustomCommandResult
      | undefined
      | Promise<CustomCommandResult>
      | Promise<undefined>
- Parameters
  - eventData: ccArg
    custom command data.
  Returns
      | CustomCommandResult
      | undefined
      | Promise<CustomCommandResult>
      | Promise<undefined>
  Command result

Example

const myCommand: cmdFuncOut = (eventData) => {
  const {source, args} = eventData
  source.sendMessage(`Hello ${name}`);
  return { status: "success" };
};