wassname/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/wassname/DefinitelyTyped.git synced 2026-08-20 12:00:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8857 from OlsonDev/patch-2

Browse Source 
Fix definitions of #bind/#unbind, merge overloads
This commit is contained in:
Horiuchi_H
2016-04-07 17:49:55 +09:00
parent 0b3fc7a433 1e2ac48780
commit 72601a148d
1 changed files with 7 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
keyboardjs/keyboardjs.d.ts
Vendored
+7 -11
View File
@@ -29,7 +29,7 @@ declare namespace keyboardjs {
/**
* Keyevent
*/
(e: KeyEvent): void;
(e?: KeyEvent): void;
}
// ---------- Key Binding ---------- //
@@ -39,21 +39,17 @@ declare namespace keyboardjs {
* @param keyCombo String of keys to be pressed to execute callbacks.
* @param pressed Callback that gets executed when the keyComboState is 'pressed', can be null.
* @param released Callback that gets executed when the keyComboState is 'released'
* @param preventRepeatByDefault Whether or not to prevent repeat by default. Defaults to false.
*/
export function bind(keyCombo: string, pressed: Callback, released: Callback): void;
/**
* Binds a keyCombo to specific callback functions.
* @param keyCombo String of keys to be pressed to execute callbacks.
* @param pressed Callback that gets executed when the keyComboState is 'pressed'
*/
export function bind(keyCombo: string, pressed: Callback): void;
export function bind(keyCombo: string | string[], pressed: Callback, released?: Callback, preventRepeatByDefault?: boolean): void;
/**
* Unbinds a keyCombo
* Unbinds a keyCombo completely or only specific pressed & released callback combos.
* @param keyCombo String of keys to be pressed to execute callbacks.
* @param pressed Callback that gets executed when the keyComboState is 'pressed', can be null.
* @param released Callback that gets executed when the keyComboState is 'released', can be null.
*/
export function unbind(keyCombo: string): void;
export function unbind(keyCombo: string | string[], pressed?: Callback, released?: Callback): void;
// ---------- Context ---------- //