tinky-keypress 1.0.2 → 1.3.0

package/README.ja-JP.md

@@ -84,7 +84,7 @@ const instance = render(
 
 ```typescript
 useKeypress(
-  handler: (key: Key) => void,
+  handler: (key: Key, raw: string) => void,
   options: { isActive: boolean }
 ): void
 ```

package/README.md

@@ -84,7 +84,7 @@ Hook to subscribe to keypress events.
 
 ```typescript
 useKeypress(
-  handler: (key: Key) => void,
+  handler: (key: Key, raw: string) => void,
   options: { isActive: boolean }
 ): void
 ```

package/README.zh-CN.md

@@ -84,7 +84,7 @@ const instance = render(
 
 ```typescript
 useKeypress(
-  handler: (key: Key) => void,
+  handler: (key: Key, raw: string) => void,
   options: { isActive: boolean }
 ): void
 ```

package/lib/contexts/KeypressContext.d.ts

@@ -1,41 +1,26 @@
-/** Timeout for waiting for a return after a backslash to detect escaped newlines */
-export declare const BACKSLASH_ENTER_TIMEOUT = 5;
-/** Timeout for waiting for more characters in an escape sequence */
-export declare const ESC_TIMEOUT = 50;
-/** Timeout for waiting for paste end sequence */
-export declare const PASTE_TIMEOUT = 30000;
-/** Timeout for discriminating between a fast return key and a pasted newline */
-export declare const FAST_RETURN_TIMEOUT = 30;
-/** Focus event sequences */
-export declare const FOCUS_IN = "\u001B[I";
-export declare const FOCUS_OUT = "\u001B[O";
+import { type Key, type KeypressHandler } from "../utils/keypress.js";
+export type { Key, KeypressHandler };
 /**
- * Represents a parsed key press event.
+ * Interface defining the shape of the Keypress context value.
+ * Used for subscribing to and unsubscribing from keypress events.
  */
-export interface Key {
-    name: string;
-    ctrl: boolean;
-    meta: boolean;
-    shift: boolean;
-    insertable: boolean;
-    sequence: string;
-}
-/**
- * Handler function type for keypress events.
- */
-export type KeypressHandler = (key: Key) => void;
 export interface KeypressContextValue {
+    /**
+     * Registers a handler function to be called when a keypress event occurs.
+     * @param handler - The function to call with the parsed Key object and raw sequence.
+     */
     subscribe: (handler: KeypressHandler) => void;
+    /**
+     * Unregisters a previously registered handler function.
+     * @param handler - The handler function to remove.
+     */
     unsubscribe: (handler: KeypressHandler) => void;
 }
 /**
- * Hook to access the Keypress context.
- * Allows components to subscribe and unsubscribe to keypress events.
- *
- * @returns The Keypress context value containing subscribe and unsubscribe methods.
- * @throws Error if used outside of a KeypressProvider.
+ * React Context for handling keypress events.
+ * Provides mechanisms to subscribe to global key input events processed from stdin.
  */
-export declare function useKeypressContext(): KeypressContextValue;
+export declare const KeypressContext: import("react").Context<KeypressContextValue | undefined>;
 /**
  * Provider component for the Keypress context.
  * Manages stdin data listening and parsing, and broadcasts key events to subscribers.