@witchcraft/spellcraft
Github
Issues
npm
Preparing search index...
core/setShortcutProp
setShortcutProp
Function setShortcutProp
setShortcutProp
<
TEntries
extends
ShortcutSetEntries
,
TProp
extends
keyof
ShortcutSetEntries
,
TEntry
extends
|
{
error
:
"DUPLICATE_KEY"
|
"DUPLICATE_SHORTCUT"
|
ChainError
;
hooks
:
GetShortcutHooks
<
"chain"
>
;
manager
:
BaseShortcutManager
&
PickManager
<
"options"
,
"stringifier"
|
"sorter"
,
>
&
Pick
<
Manager
,
"shortcuts"
|
"commands"
|
"keys"
>
;
val
:
string
[]
[]
;
}
|
{
error
:
"UNKNOWN_COMMAND"
;
hooks
:
GetShortcutHooks
<
"command"
>
;
manager
:
BaseShortcutManager
&
PickManager
<
"options"
,
"stringifier"
>
&
Pick
<
Manager
,
"commands"
,
>
&
Partial
<
Pick
<
Manager
,
"keys"
>
>
;
val
:
undefined
|
string
;
}
|
{
error
:
never
;
hooks
:
GetShortcutHooks
<
"condition"
>
;
manager
:
never
;
val
:
Condition
;
}
|
{
error
:
never
;
hooks
:
GetShortcutHooks
<
"enabled"
>
;
manager
:
never
;
val
:
boolean
;
}
|
{
error
:
never
;
hooks
:
GetShortcutHooks
<
"forceUnequal"
>
;
manager
:
never
;
val
:
boolean
;
}
,
THooks
extends
Partial
<
Hooks
>
,
TCheck
extends
boolean
|
"only"
=
true
,
>
(
shortcut
:
Shortcut
,
prop
:
TProp
,
val
:
TEntry
[
"val"
]
,
manager
:
(
TEntry
[
"manager"
]
extends
never
?
unknown
:
TEntry
[
"manager"
]
)
&
{
hooks
?:
THooks
;
}
,
__namedParameters
?:
{
check
?:
TCheck
}
,
)
:
Result
<
TCheck
extends
"only"
?
true
:
Shortcut
<
string
,
Condition
>
,
|
MultipleErrors
<
TEntry
[
"error"
]
>
|
CanHookErrors
<
THooks
,
"canSetShortcutProp"
>
,
>
Type Parameters
TEntries
extends
ShortcutSetEntries
TProp
extends
keyof
ShortcutSetEntries
TEntry
extends
|
{
error
:
"DUPLICATE_KEY"
|
"DUPLICATE_SHORTCUT"
|
ChainError
;
hooks
:
GetShortcutHooks
<
"chain"
>
;
manager
:
BaseShortcutManager
&
PickManager
<
"options"
,
"stringifier"
|
"sorter"
,
>
&
Pick
<
Manager
,
"shortcuts"
|
"commands"
|
"keys"
>
;
val
:
string
[]
[]
;
}
|
{
error
:
"UNKNOWN_COMMAND"
;
hooks
:
GetShortcutHooks
<
"command"
>
;
manager
:
BaseShortcutManager
&
PickManager
<
"options"
,
"stringifier"
>
&
Pick
<
Manager
,
"commands"
,
>
&
Partial
<
Pick
<
Manager
,
"keys"
>
>
;
val
:
undefined
|
string
;
}
|
{
error
:
never
;
hooks
:
GetShortcutHooks
<
"condition"
>
;
manager
:
never
;
val
:
Condition
;
}
|
{
error
:
never
;
hooks
:
GetShortcutHooks
<
"enabled"
>
;
manager
:
never
;
val
:
boolean
;
}
|
{
error
:
never
;
hooks
:
GetShortcutHooks
<
"forceUnequal"
>
;
manager
:
never
;
val
:
boolean
;
}
THooks
extends
Partial
<
Hooks
>
TCheck
extends
boolean
|
"only"
=
true
Parameters
shortcut
:
Shortcut
Shortcut is mutated if check is not "only".
prop
:
TProp
val
:
TEntry
[
"val"
]
manager
: (
TEntry
[
"manager"
]
extends
never
?
unknown
:
TEntry
[
"manager"
]
)
&
{
hooks
?:
THooks
;
}
__namedParameters
:
{
check
?:
TCheck
}
= {}
Returns
Result
<
TCheck
extends
"only"
?
true
:
Shortcut
<
string
,
Condition
>
,
|
MultipleErrors
<
TEntry
[
"error"
]
>
|
CanHookErrors
<
THooks
,
"canSetShortcutProp"
>
,
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
Github
Issues
npm
@witchcraft/spellcraft
Loading...
Shortcut is mutated if check is not "only".