UNPKG

@ahmic/autoit-js

Version:
48 lines (47 loc) 1.25 kB
/** * Enumeration for scroll directions. */ export declare enum ScrollDirection { /** * Scrolls up. */ Up = "up", /** * Scrolls down. */ Down = "down" } /** * Scrolls the mouse wheel. * * @param direction The direction to scroll (up or down). * @param clicks The number of clicks to scroll. Defaults to 1. * * @example * ```typescript * import { MouseWheelSync, ScrollDirection } from '@ahmic/autoit-js'; * * MouseWheelSync(ScrollDirection.Up, 3); * MouseWheelSync(ScrollDirection.Down, 2); * ``` * * @see https://www.autoitscript.com/autoit3/docs/functions/MouseWheel.htm */ export declare function MouseWheelSync(direction: ScrollDirection, clicks?: number): void; /** * Scrolls the mouse wheel. * * @param direction The direction to scroll (up or down). * @param clicks The number of clicks to scroll. Defaults to 1. * * @example * ```typescript * import { MouseWheel, ScrollDirection } from '@ahmic/autoit-js'; * * await MouseWheel(ScrollDirection.Up, 3); * await MouseWheel(ScrollDirection.Down, 2); * ``` * * @see https://www.autoitscript.com/autoit3/docs/functions/MouseWheel.htm */ export declare function MouseWheel(direction: ScrollDirection, clicks?: number): Promise<void>;