Saxonberg Server API
Preparing search index...
mud/lib/command/CommandGiver
CommandGiver
Interface CommandGiver
Public shape provided by CommandGiverMixin.
interface
CommandGiver
{
executeCommand
(
commandText
:
string
,
opts
?:
ExecuteCommandOpts
,
)
:
Promise
<
void
>
;
getAffordances
()
:
Affordance
[]
;
getAvailableCommands
()
:
CommandDefinition
[]
;
popCommandSource
(
source
:
RecencySource
)
:
void
;
pushCommandSource
(
source
:
RecencySource
,
bucket
:
RecencyBucket
,
defs
:
CommandDefinition
[]
,
)
:
void
;
resetCommandSources
(
reason
:
"self-moved"
)
:
void
;
}
Index
Methods
execute
Command
get
Affordances
get
Available
Commands
pop
Command
Source
push
Command
Source
reset
Command
Sources
Methods
execute
Command
executeCommand
(
commandText
:
string
,
opts
?:
ExecuteCommandOpts
)
:
Promise
<
void
>
Parameters
commandText
:
string
Optional
opts
:
ExecuteCommandOpts
Returns
Promise
<
void
>
get
Affordances
getAffordances
()
:
Affordance
[]
Returns
Affordance
[]
get
Available
Commands
getAvailableCommands
()
:
CommandDefinition
[]
Returns
CommandDefinition
[]
pop
Command
Source
popCommandSource
(
source
:
RecencySource
)
:
void
Parameters
source
:
RecencySource
Returns
void
push
Command
Source
pushCommandSource
(
source
:
RecencySource
,
bucket
:
RecencyBucket
,
defs
:
CommandDefinition
[]
,
)
:
void
Parameters
source
:
RecencySource
bucket
:
RecencyBucket
defs
:
CommandDefinition
[]
Returns
void
reset
Command
Sources
resetCommandSources
(
reason
:
"self-moved"
)
:
void
Parameters
reason
:
"self-moved"
Returns
void
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
execute
Command
get
Affordances
get
Available
Commands
pop
Command
Source
push
Command
Source
reset
Command
Sources
Saxonberg Server API
Loading...
Public shape provided by CommandGiverMixin.