@witchcraft/spellcraft
Github
Issues
npm
Preparing search index...
core/setKeysProp
setKeysProp
Function setKeysProp
setKeysProp
<
TEntries
extends
KeysSetEntries
,
TProp
extends
|
"entries@add"
|
"entries@remove"
|
`
toggles@add@
${
string
}
`
|
`
toggles@remove@
${
string
}
`
|
`
variants@add@
${
string
}
`
|
`
variants@remove@
${
string
}
`
|
"nativeModifierKeys"
|
"nativeToggleKeys"
|
"layout"
,
TEntry
extends
|
{
error
:
"INVALID_VARIANT_PAIR"
|
"DUPLICATE_KEY"
;
hooks
:
GetKeyHooks
<
"entries@add"
>
;
manager
:
BaseKeysManager
;
val
:
Key
;
}
|
{
error
:
"MISSING"
|
"KEY_IN_USE"
;
hooks
:
GetKeyHooks
<
"entries@remove"
>
;
manager
:
PickManager
<
"options"
,
"stringifier"
>
&
Record
<
any
,
any
>
&
Pick
<
Manager
,
"keys"
,
>
&
Pick
<
Manager
,
"shortcuts"
|
"commands"
>
;
val
:
Key
;
}
|
{
error
:
never
;
hooks
:
GetKeyHooks
<
`
variants@
${
"add"
|
"remove"
}
@
${
string
}
`
>
;
manager
:
BaseKeysManager
;
val
:
Key
;
}
|
{
error
:
never
;
hooks
:
GetKeyHooks
<
`
variants@
${
"add"
|
"remove"
}
@
${
string
}
`
>
;
manager
:
BaseKeysManager
;
val
:
string
;
}
|
{
error
:
never
;
hooks
:
GetKeyHooks
<
"nativeModifierKeys"
|
"nativeToggleKeys"
>
;
manager
:
BaseKeysManager
;
val
:
string
[]
;
}
|
{
error
:
never
;
hooks
:
GetKeyHooks
<
"layout"
>
;
manager
:
BaseKeysManager
;
val
:
{
x
:
number
;
y
:
number
}
;
}
,
THooks
extends
Partial
<
Hooks
>
,
TCheck
extends
boolean
|
"only"
=
true
,
>
(
prop
:
TProp
,
val
:
TEntry
[
"val"
]
,
manager
:
TEntry
[
"manager"
]
&
{
hooks
?:
THooks
}
,
__namedParameters
?:
{
check
?:
TCheck
}
,
)
:
Result
<
TCheck
extends
"only"
?
true
:
Key
,
MultipleErrors
<
TEntry
[
"error"
]
>
|
CanHookErrors
<
THooks
,
"canSetKeysProp"
>
,
>
Sets a settable
Keys
property.
Type Parameters
TEntries
extends
KeysSetEntries
TProp
extends
|
"entries@add"
|
"entries@remove"
|
`
toggles@add@
${
string
}
`
|
`
toggles@remove@
${
string
}
`
|
`
variants@add@
${
string
}
`
|
`
variants@remove@
${
string
}
`
|
"nativeModifierKeys"
|
"nativeToggleKeys"
|
"layout"
TEntry
extends
|
{
error
:
"INVALID_VARIANT_PAIR"
|
"DUPLICATE_KEY"
;
hooks
:
GetKeyHooks
<
"entries@add"
>
;
manager
:
BaseKeysManager
;
val
:
Key
;
}
|
{
error
:
"MISSING"
|
"KEY_IN_USE"
;
hooks
:
GetKeyHooks
<
"entries@remove"
>
;
manager
:
PickManager
<
"options"
,
"stringifier"
>
&
Record
<
any
,
any
>
&
Pick
<
Manager
,
"keys"
,
>
&
Pick
<
Manager
,
"shortcuts"
|
"commands"
>
;
val
:
Key
;
}
|
{
error
:
never
;
hooks
:
GetKeyHooks
<
`
variants@
${
"add"
|
"remove"
}
@
${
string
}
`
>
;
manager
:
BaseKeysManager
;
val
:
Key
;
}
|
{
error
:
never
;
hooks
:
GetKeyHooks
<
`
variants@
${
"add"
|
"remove"
}
@
${
string
}
`
>
;
manager
:
BaseKeysManager
;
val
:
string
;
}
|
{
error
:
never
;
hooks
:
GetKeyHooks
<
"nativeModifierKeys"
|
"nativeToggleKeys"
>
;
manager
:
BaseKeysManager
;
val
:
string
[]
;
}
|
{
error
:
never
;
hooks
:
GetKeyHooks
<
"layout"
>
;
manager
:
BaseKeysManager
;
val
:
{
x
:
number
;
y
:
number
}
;
}
THooks
extends
Partial
<
Hooks
>
TCheck
extends
boolean
|
"only"
=
true
Parameters
prop
:
TProp
val
:
TEntry
[
"val"
]
manager
:
TEntry
[
"manager"
]
&
{
hooks
?:
THooks
}
__namedParameters
:
{
check
?:
TCheck
}
= {}
Returns
Result
<
TCheck
extends
"only"
?
true
:
Key
,
MultipleErrors
<
TEntry
[
"error"
]
>
|
CanHookErrors
<
THooks
,
"canSetKeysProp"
>
,
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
Github
Issues
npm
@witchcraft/spellcraft
Loading...
Sets a settable Keys property.