@ahmic/autoit-js/dist/mouse-get-pos.d.ts

Node.js bindings for AutoItX3.dll

import { Point } from './@types';
/**
 * Retrieves the current position of the mouse cursor.
 *
 * @returns A {@link Point} object containing the x and y coordinates of the mouse cursor.
 *
 * @example
 * ```typescript
 * import { MouseGetPosSync } from '@ahmic/autoit-js';
 *
 * const position = MouseGetPosSync();
 *
 * console.log(position); // Output: { x: 100, y: 200 }
 * ```
 *
 * @see https://www.autoitscript.com/autoit3/docs/functions/MouseGetPos.htm
 */
export declare function MouseGetPosSync(): Point;
/**
 * Retrieves the current position of the mouse cursor.
 *
 * @returns A promise that resolves to a {@link Point} object containing the x and y coordinates of the mouse
 * cursor.
 *
 * @example
 * ```typescript
 * import { MouseGetPos } from '@ahmic/autoit-js';
 *
 * const position = await MouseGetPos();
 *
 * console.log(position); // Output: { x: 100, y: 200 }
 * ```
 *
 * @see https://www.autoitscript.com/autoit3/docs/functions/MouseGetPos.htm
 */
export declare function MouseGetPos(): Promise<Point>;