From 584a02ef43de615d9e681fc856b2919f26b61f8f Mon Sep 17 00:00:00 2001
From: Jelf <353742991@qq.com>
Date: Tue, 12 Jul 2022 23:00:42 +0800
Subject: [PATCH] fix(useKeyModifier)!: rename type `ModifierOptions` to
 `UseModifierOptions` (#1871)

---
 packages/core/useKeyModifier/index.ts | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/packages/core/useKeyModifier/index.ts b/packages/core/useKeyModifier/index.ts
index 4c79af25d3b..889cbdb5b92 100644
--- a/packages/core/useKeyModifier/index.ts
+++ b/packages/core/useKeyModifier/index.ts
@@ -9,7 +9,7 @@ export type KeyModifier = 'Alt' | 'AltGraph' | 'CapsLock' | 'Control' | 'Fn' | '
 
 const defaultEvents: WindowEventName[] = ['mousedown', 'mouseup', 'keydown', 'keyup']
 
-export interface ModifierOptions<Initial> extends ConfigurableDocument {
+export interface UseModifierOptions<Initial> extends ConfigurableDocument {
   /**
    * Event names that will prompt update to modifier states
    *
@@ -25,7 +25,9 @@ export interface ModifierOptions<Initial> extends ConfigurableDocument {
   initial?: Initial
 }
 
-export function useKeyModifier<Initial extends boolean | null>(modifier: KeyModifier, options: ModifierOptions<Initial> = {}) {
+export type UseKeyModifierReturn<Initial> = Ref<Initial extends boolean ? boolean : boolean | null>
+
+export function useKeyModifier<Initial extends boolean | null>(modifier: KeyModifier, options: UseModifierOptions<Initial> = {}): UseKeyModifierReturn<Initial> {
   const {
     events = defaultEvents,
     document = defaultDocument,
@@ -43,5 +45,5 @@ export function useKeyModifier<Initial extends boolean | null>(modifier: KeyModi
     })
   }
 
-  return state as Ref<Initial extends boolean ? boolean : boolean | null>
+  return state
 }