Interface IItemOptions

An options object for creating a command item.

interface IItemOptions {
    args?: ReadonlyJSONObject;
    category: string;
    command: string;
    rank?: number;
}

Properties

args?: ReadonlyJSONObject

The arguments for the command.

The default value is an empty object.

command: string

The command to execute when the item is triggered.

rank?: number

The rank for the command item.

The rank is used as a tie-breaker when ordering command items for display. Items are sorted in the following order:

The default rank is Infinity.