Tego Bot API Documentation v0.2.0

---

Tego Bot API Documentation / keyToggle

Function: keyToggle()

keyToggle(key, down, modifier?): void

Defined in: botjs/src/index.ts:276

Toggle a key state (press down or release up)

Parameters

key

string

Key to toggle

down

string

"down" to press, "up" to release

modifier?

string[]

Optional array of modifier keys

Returns

void

Example

import { keyToggle, keyTap } from "@tego/botjs";

// Hold Shift
keyToggle('shift', 'down');

// Type 'HELLO' (all caps due to Shift being held)
keyTap('h');
keyTap('e');
keyTap('l');
keyTap('l');
keyTap('o');

// Release Shift
keyToggle('shift', 'up');