tiny-essentials 1.28.0 → 1.28.2

package/dist/v1/libs/TinyGamepad.d.mts

@@ -1,7 +1,3 @@
-export default TinyGamepad;
-/**
- * Describes the status of a key or button.
- */
 export type KeyStatus = {
     /**
      * - Whether the key is currently pressed.
@@ -10,84 +6,30 @@ export type KeyStatus = {
     /**
      * - Optional analog value associated with the key.
      */
-    value?: number | undefined;
+    value?: number;
     /**
      * - Optional second analog value.
      */
-    value2?: number | undefined;
+    value2?: number;
 };
-/**
- * Defines the available input modes.
- */
-export type InputMode = "gamepad-only" | "keyboard-only" | "both";
-/**
- * A callback function that is invoked when a mapped logical input is activated or deactivated.
- *
- * This function receives the logical name associated with the input (e.g., "Jump", "Shoot", "Menu")
- * and can be used to handle input-related actions such as triggering game mechanics or UI behavior.
- */
+export type InputMode = 'gamepad-only' | 'keyboard-only' | 'both';
 export type MappedInputCallback = (payload: {
     logicalName: string;
     activeTime: number;
     comboTime: number;
 }) => void;
-/**
- * A callback function that is invoked when a mapped key is activated or deactivated.
- *
- * This function receives the key name associated with the input (e.g., "KeyA", "KeyB", "KeyC")
- * and can be used to handle input-related actions such as triggering game mechanics or UI behavior.
- */
 export type MappedKeyCallback = (payload: {
     key: string;
     activeTime: number;
 }) => void;
-/**
- * Callback for handling input events.
- */
 export type PayloadCallback = (payload: InputPayload | InputAnalogPayload) => void;
-/**
- * Callback for handling gamepad connection events.
- */
 export type ConnectionCallback = (payload: ConnectionPayload) => void;
-/**
- * A callback function that is triggered when a registered input sequence is fully activated.
- */
 export type InputSequenceCallback = (timestamp: number) => any;
-/**
- * A callback function that is triggered when a registered key sequence is fully activated.
- */
 export type KeySequenceCallback = (timestamp: number) => any;
-/**
- * Represents any valid callback type used in the TinyGamepad event system.
- * This is a union of all supported callback signatures.
- */
 export type CallbackList = ConnectionCallback | PayloadCallback | MappedInputCallback | MappedKeyCallback;
-/**
- * Represents a specific input source from a gamepad.
- * - 'gamepad-analog' refers to analog sticks or analog triggers.
- * - 'gamepad-button' refers to digital buttons on the gamepad.
- */
-export type GamepadDeviceSource = "gamepad-analog" | "gamepad-button";
-/**
- * Represents any possible physical device source that can be used for input.
- * - 'mouse': Input from a mouse.
- * - 'keyboard': Input from a keyboard.
- * - 'gamepad-analog': Analog input from a gamepad (e.g., sticks, triggers).
- * - 'gamepad-button': Digital button input from a gamepad.
- */
-export type DeviceSource = "mouse" | "keyboard" | GamepadDeviceSource;
-/**
- * Represents the type of input interaction detected.
- * - 'up': Input was released.
- * - 'down': Input was pressed.
- * - 'hold': Input is being held.
- * - 'change': Input value changed (e.g., pressure or axis).
- * - 'move': Analog movement detected (e.g., joystick motion).
- */
-export type DeviceInputType = "up" | "down" | "hold" | "change" | "move";
-/**
- * Structure for digital button input payload.
- */
+export type GamepadDeviceSource = 'gamepad-analog' | 'gamepad-button';
+export type DeviceSource = 'mouse' | 'keyboard' | GamepadDeviceSource;
+export type DeviceInputType = 'up' | 'down' | 'hold' | 'change' | 'move';
 export type InputPayload = {
     /**
      * - Unique identifier for the input.
@@ -96,7 +38,7 @@ export type InputPayload = {
     /**
      * - Optional DOM event reference.
      */
-    event?: Event | undefined;
+    event?: Event;
     /**
      * - Type of input event (down, up, hold).
      */
@@ -132,7 +74,7 @@ export type InputPayload = {
     /**
      * - Previous pressed status.
      */
-    prevPressed?: boolean | null | undefined;
+    prevPressed?: boolean | null;
     /**
      * - Timestamp of the event.
      */
@@ -140,11 +82,8 @@ export type InputPayload = {
     /**
      * - Reference to the originating Gamepad.
      */
-    gp?: Gamepad | undefined;
+    gp?: Gamepad;
 };
-/**
- * Structure for analog input payload.
- */
 export type InputAnalogPayload = {
     /**
      * - Unique identifier for the input.
@@ -153,7 +92,7 @@ export type InputAnalogPayload = {
     /**
      * - Optional DOM event reference.
      */
-    event?: Event | undefined;
+    event?: Event;
     /**
      * - Type of input event (change).
      */
@@ -185,11 +124,8 @@ export type InputAnalogPayload = {
     /**
      * - Reference to the originating Gamepad.
      */
-    gp?: Gamepad | undefined;
+    gp?: Gamepad;
 };
-/**
- * Internal structure for digital input events.
- */
 export type InputEvents = {
     /**
      * - Unique identifier for the input.
@@ -198,7 +134,7 @@ export type InputEvents = {
     /**
      * - Optional DOM event reference.
      */
-    event?: Event | undefined;
+    event?: Event;
     /**
      * - Input key identifier.
      */
@@ -230,7 +166,7 @@ export type InputEvents = {
     /**
      * - Previous pressed status.
      */
-    prevPressed?: boolean | null | undefined;
+    prevPressed?: boolean | null;
     /**
      * - Timestamp of the event.
      */
@@ -238,11 +174,8 @@ export type InputEvents = {
     /**
      * - Reference to the gamepad.
      */
-    gp?: Gamepad | undefined;
+    gp?: Gamepad;
 };
-/**
- * Internal structure for analog input events.
- */
 export type InputAnalogEvents = {
     /**
      * - Unique identifier for the input.
@@ -251,7 +184,7 @@ export type InputAnalogEvents = {
     /**
      * - Optional DOM event reference.
      */
-    event?: Event | undefined;
+    event?: Event;
     /**
      * - Analog key.
      */
@@ -279,11 +212,8 @@ export type InputAnalogEvents = {
     /**
      * - Gamepad reference.
      */
-    gp?: Gamepad | undefined;
+    gp?: Gamepad;
 };
-/**
- * Payload for connection-related events.
- */
 export type ConnectionPayload = {
     /**
      * - ID of the gamepad.
@@ -492,8 +422,7 @@ export type ExportedConfig = {
  * detailed input feedback, and JSON-based profile serialization for saving and restoring mappings.
  */
 declare class TinyGamepad {
-    /** @type {Record<string, string>} */
-    static #specialMap: Record<string, string>;
+    #private;
     /**
      * Add or update a special key mapping.
      * @param {string} char - The character to map.
@@ -541,14 +470,14 @@ declare class TinyGamepad {
      * @param {Window|Element} [options.elementBase=window] - The DOM element or window to bind keyboard and mouse events to.
      */
     constructor({ expectedId, inputMode, ignoreIds, deadZone, axisActiveSensitivity, timeoutComboKeys, allowMouse, elementBase, }?: {
-        expectedId?: string | null | undefined;
-        inputMode?: InputMode | undefined;
-        ignoreIds?: string[] | undefined;
-        deadZone?: number | undefined;
-        allowMouse?: boolean | undefined;
-        timeoutComboKeys?: number | undefined;
-        axisActiveSensitivity?: number | undefined;
-        elementBase?: Element | Window | undefined;
+        expectedId?: string | null;
+        inputMode?: InputMode;
+        ignoreIds?: string[];
+        deadZone?: number;
+        allowMouse?: boolean;
+        timeoutComboKeys?: number;
+        axisActiveSensitivity?: number;
+        elementBase?: Window | Element;
     });
     /**
      * Waits for a single input event from the user and resolves with detailed input information.
@@ -570,9 +499,9 @@ declare class TinyGamepad {
      *   - `gp`: the Gamepad object (only if the input source is a gamepad).
      */
     awaitInputMapping({ timeout, eventName, canMove }?: {
-        timeout?: number | undefined;
-        eventName?: string | undefined;
-        canMove?: boolean | undefined;
+        timeout?: number;
+        eventName?: string;
+        canMove?: boolean;
     }): Promise<{
         key: string | null;
         source: DeviceSource | null;
@@ -906,20 +835,20 @@ declare class TinyGamepad {
      * @param {'all' | 'start' | 'end' | 'hold' | 'change' | 'move'} [type='all']
      * @returns {Function[]}
      */
-    getCalls(logicalName: string, type?: "all" | "start" | "end" | "hold" | "change" | "move"): Function[];
+    getCalls(logicalName: string, type?: 'all' | 'start' | 'end' | 'hold' | 'change' | 'move'): Function[];
     /**
      * Removes all callbacks for a specific logical input event.
      * @param {string} logicalName
      * @param {'all'| 'start' | 'end' | 'hold' | 'change' | 'move'} [type='all']
      */
-    offAllInputs(logicalName: string, type?: "all" | "start" | "end" | "hold" | "change" | "move"): void;
+    offAllInputs(logicalName: string, type?: 'all' | 'start' | 'end' | 'hold' | 'change' | 'move'): void;
     /**
      * Returns the number of registered callbacks for a specific logical input and type.
      * @param {string} logicalName
      * @param {'all' | 'start' | 'end' | 'hold' | 'change' | 'move'} [type='all']
      * @returns {number}
      */
-    getCallSize(logicalName: string, type?: "all" | "start" | "end" | "hold" | "change" | "move"): number;
+    getCallSize(logicalName: string, type?: 'all' | 'start' | 'end' | 'hold' | 'change' | 'move'): number;
     /**
      * Returns the current default haptic feedback effect configuration.
      *
@@ -1220,6 +1149,11 @@ declare class TinyGamepad {
      * @returns {number}
      */
     get timeMappedInputs(): number;
+    /**
+     * Returns the timeout duration (in milliseconds) before raw key combos are reset.
+     * @returns {number}
+     */
+    get timeoutComboKeys(): number;
     /**
      * Sets the timeout duration (in milliseconds) before raw key combos are reset.
      * Must be a positive number.
@@ -1227,10 +1161,14 @@ declare class TinyGamepad {
      */
     set timeoutComboKeys(value: number);
     /**
-     * Returns the timeout duration (in milliseconds) before raw key combos are reset.
-     * @returns {number}
+     * Gets the sensitivity threshold used to detect when an axis (like a thumbstick or trigger)
+     * is considered "actively moved". This helps distinguish minor noise from intentional input.
+     *
+     * A value of 0 means even the slightest movement is detected; a value closer to 1 means only strong input is accepted.
+     *
+     * @returns {number} The current axis activity sensitivity (between 0 and 1).
      */
-    get timeoutComboKeys(): number;
+    get axisActiveSensitivity(): number;
     /**
      * Sets the sensitivity threshold used to detect active axis input.
      * This value defines how far an analog axis (such as a thumbstick or trigger) must move from its rest position
@@ -1242,14 +1180,10 @@ declare class TinyGamepad {
      */
     set axisActiveSensitivity(value: number);
     /**
-     * Gets the sensitivity threshold used to detect when an axis (like a thumbstick or trigger)
-     * is considered "actively moved". This helps distinguish minor noise from intentional input.
-     *
-     * A value of 0 means even the slightest movement is detected; a value closer to 1 means only strong input is accepted.
-     *
-     * @returns {number} The current axis activity sensitivity (between 0 and 1).
+     * Returns the current dead zone threshold for analog inputs.
+     * @returns {number}
      */
-    get axisActiveSensitivity(): number;
+    get deadZone(): number;
     /**
      * Sets a new dead zone threshold for analog inputs.
      * Must be a number between 0 and 1.
@@ -1257,20 +1191,14 @@ declare class TinyGamepad {
      */
     set deadZone(value: number);
     /**
-     * Returns the current dead zone threshold for analog inputs.
-     * @returns {number}
+     * Returns the expected device ID, or null if any is accepted.
+     * @returns {string|null}
      */
-    get deadZone(): number;
+    get expectedId(): string | null;
     /**
      * Sets the expected device ID.
-     * @returns {string}
      */
     set expectedId(value: string | null);
-    /**
-     * Returns the expected device ID, or null if any is accepted.
-     * @returns {string|null}
-     */
-    get expectedId(): string | null;
     /**
      * Returns whether the instance has been destroyed
      * @returns {boolean}
@@ -1281,6 +1209,6 @@ declare class TinyGamepad {
      * Marks the instance as destroyed.
      */
     destroy(): void;
-    #private;
 }
+export default TinyGamepad;
 //# sourceMappingURL=TinyGamepad.d.mts.map