vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-06-28 14:20:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix definitions of #bind/#unbind, merge overloads

Browse Source 
See https://github.com/RobertWHurst/KeyboardJS/blob/master/lib/keyboard.js#L54 for bind()
See https://github.com/RobertWHurst/KeyboardJS/blob/master/lib/keyboard.js#L84 for unbind()
This commit is contained in:
Josh Olson
2016-04-05 15:49:31 -05:00
parent 513510a89a
commit 9636ae9d5e
1 changed files with 6 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
keyboardjs/keyboardjs.d.ts vendored
View File

@@ -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 ---------- //