(#87) Movement API docs

Author: s1hofmann

lib/movement-api.interface.ts

@@ -0,0 +1,32 @@
+import { Point } from "./point.class";
+
+/**
+ * {@link MovementApi} provides helper functions to generate movement paths relative tot he current mouse position
+ */
+export interface MovementApi {
+  /**
+   * {@link down} generates a downward movement path
+   * @param px Length of the movement path in pixels
+   */
+  down(px: number): Promise<Point[]>;
+  /**
+   * {@link left} generates a leftward movement path
+   * @param px Length of the movement path in pixels
+   */
+  left(px: number): Promise<Point[]>;
+  /**
+   * {@link right} generates a rightward movement path
+   * @param px Length of the movement path in pixels
+   */
+  right(px: number): Promise<Point[]>;
+  /**
+   * {@link straightTo} generates a straight movement path to a given target {@link Point}
+   * @param target The target {@link Point} to move towards
+   */
+  straightTo(target: Point | Promise<Point>): Promise<Point[]>;
+  /**
+   * {@link up} generates a upward movement path
+   * @param px Length of the movement path in pixels
+   */
+  up(px: number): Promise<Point[]>;
+}

lib/movement.function.ts

@@ -1,8 +1,9 @@
 import { NativeAdapter } from "./adapter/native.adapter.class";
+import { MovementApi } from "./movement-api.interface";
 import { Point } from "./point.class";
 import { LineHelper } from "./util/linehelper.class";
 
-export const createMovementApi = (native: NativeAdapter, lineHelper: LineHelper) => {
+export const createMovementApi = (native: NativeAdapter, lineHelper: LineHelper): MovementApi => {
   return ({
     down: async (px: number): Promise<Point[]> => {
       const pos = await native.currentMousePosition();