new Command
A Command is a function with an extra canExecute observable property to determine
whether the command can be executed. When executed, a Command function will check the
value of canExecute and throw if false.
This type describes an interface and is not intended to be instantiated directly.
See createCommand to create a command from a function.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
execute |
Function | The function this command represents. | ||
canExecute |
Observable |
<optional> |
true | An observable indicating if the function can currently be executed. |
Source:
Members
-
afterExecute :Event
-
An event which is raised after the command executes, the event is raised with the return value of the command as its only parameter.
-
beforeExecute :Event
-
An event which is raised before the command executes, the event is raised with an object containing two properties: a
cancelproperty, which if set to false by the listener will prevent the command from being executed, and anargsproperty, which is the array of arguments being passed to the command. -
canExecute :Observable
-
Indicates if this command can currently be executed.