@reactuses/core 1.1.4 → 1.1.5

package/dist/index.d.ts

@@ -171,12 +171,35 @@ declare function useCounter(initialValue?: number | (() => number), max?: number
 type RafLoopReturns = readonly [() => void, () => void, () => boolean];
 declare function useRafFn(callback: FrameRequestCallback, initiallyActive?: boolean): RafLoopReturns;
 
+interface IListener<T, U = void> {
+    (arg1: T, arg2: U): void;
+}
 interface IDisposable {
     dispose(): void;
 }
 interface IEvent<T, U = void> {
     (listener: (arg1: T, arg2: U) => any): IDisposable;
 }
+interface IEventOnce<T, U = void> {
+    (listener: (arg1: T, arg2: U) => any): void;
+}
+interface UseEventEmitterReturn<T, U = void> {
+    /**
+     * Subscribe to an event. When calling emit, the listeners will execute.
+     * @param listener watch listener.
+     * @returns a stop function to remove the current callback.
+     */
+    event: IEvent<T, U>;
+    /**
+     * fire an event, the corresponding event listeners will execute.
+     * @param event data sent.
+     */
+    fire: (arg1: T, arg2: U) => void;
+    /**
+     * Remove all corresponding listener.
+     */
+    dispose: () => void;
+}
 declare function useEventEmitter<T, U = void>(): readonly [IEvent<T, U>, (arg1: T, arg2: U) => void, () => void];
 
 declare function useFavicon(href: string, baseUrl?: string, rel?: string): void;
@@ -235,11 +258,11 @@ type GeneralPermissionDescriptor = PermissionDescriptor | {
 };
 declare function usePermission(permissionDesc: GeneralPermissionDescriptor | GeneralPermissionDescriptor["name"]): IState;
 
-interface Options$1 {
+interface UseLongPressOptions {
     isPreventDefault?: boolean;
     delay?: number;
 }
-declare function useLongPress(callback: (e: TouchEvent | MouseEvent) => void, { isPreventDefault, delay }?: Options$1): {
+declare function useLongPress(callback: (e: TouchEvent | MouseEvent) => void, { isPreventDefault, delay }?: UseLongPressOptions): {
     readonly onMouseDown: (e: any) => void;
     readonly onTouchStart: (e: any) => void;
     readonly onMouseUp: () => void;
@@ -301,11 +324,11 @@ declare function useGeolocation(options?: Partial<PositionOptions>): {
     readonly error: GeolocationPositionError | null;
 };
 
-interface Options {
+interface UseFullScreenOptions {
     onExit?: () => void;
     onEnter?: () => void;
 }
-declare function useFullscreen(target: BasicTarget, options?: Options): readonly [boolean, {
+declare function useFullscreen(target: BasicTarget, options?: UseFullScreenOptions): readonly [boolean, {
     readonly enterFullscreen: () => void;
     readonly exitFullscreen: () => void;
     readonly toggleFullscreen: () => void;
@@ -726,4 +749,4 @@ declare const _default$1: typeof useEffect | typeof react.useLayoutEffect;
 
 declare const _default: typeof react.useEffect | typeof useLayoutEffect;
 
-export { useActiveElement, useClickOutSide as useClickOutside, useClipBorad as useClipboard, useControlled, useCounter, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDocumentVisibility, useDraggable, useDropZone, useElementBounding, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useFavicon, useFileDialog, useFirstMountState, useFocus, _default$2 as useFps, useFullscreen, useGeolocation, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLongPress, _default$3 as useMediaDevices, useMediaQuery, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, _default$1 as useOnceEffect, _default as useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePrevious, useRafFn, useRafState, useResizeObserver, useScriptTag, useScroll, useScrollLock, useSessionStorage, useTextDirection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, _default$5 as useUpdateEffect, _default$4 as useUpdateLayoutEffect, useVirtualList, useWindowScroll, useWindowSize, useWindowsFocus };
+export { ColorScheme, Contrast, CursorState, GeneralPermissionDescriptor, IDisposable, IEvent, IEventOnce, IListener, INetworkInformation, IState, IUseNetworkState, KeyModifier, MousePressedOptions, MouseSourceType, OrientationState, RafLoopReturns, State, Status, Target, UseDarkOptions, UseDraggableOptions, UseElementBoundingOptions, UseEventEmitterReturn, UseFileDialogOptions, UseFpsOptions, UseFullScreenOptions, UseInfiniteScrollOptions, UseLongPressOptions, UseModifierOptions, UseScriptTagOptions, UseScrollOptions, UseTextDirectionOptions, UseTextDirectionValue, UseTimeoutFnOptions, UseVirtualListItem, UseVirtualListOptions, UseVirtualListReturn, WindowSize, useActiveElement, useClickOutSide as useClickOutside, useClipBorad as useClipboard, useControlled, useCounter, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDocumentVisibility, useDraggable, useDropZone, useElementBounding, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useFavicon, useFileDialog, useFirstMountState, useFocus, _default$2 as useFps, useFullscreen, useGeolocation, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLongPress, _default$3 as useMediaDevices, useMediaQuery, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, _default$1 as useOnceEffect, _default as useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePrevious, useRafFn, useRafState, useResizeObserver, useScriptTag, useScroll, useScrollLock, useSessionStorage, useTextDirection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, _default$5 as useUpdateEffect, _default$4 as useUpdateLayoutEffect, useVirtualList, useWindowScroll, useWindowSize, useWindowsFocus };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactuses/core",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -76,6 +76,9 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.8.2"
   },
+  "peerDependencies": {
+    "react": "^16.8.0  || ^17.0.0 || ^18.0.0"
+  },
   "keywords": [
     "react",
     "react-use",