react-transition-state 1.2.0-alpha.2 → 1.2.0-alpha.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-transition-state",
-  "version": "1.2.0-alpha.2",
+  "version": "1.2.0-alpha.3",
   "description": "Zero dependency, 0.7KB react-transition-group alternative.",
   "author": "Zheng Song",
   "license": "MIT",

package/types/index.d.ts

@@ -7,6 +7,12 @@ export type TransitionState =
   | 'exited'
   | 'unmounted';
 
+export interface State {
+  state: TransitionState;
+  isMounted: boolean;
+  isEnter: boolean;
+}
+
 export interface TransitionOptions {
   initialEntered?: boolean;
   mountOnEnter?: boolean;
@@ -19,26 +25,26 @@ export interface TransitionOptions {
   onChange?: (event: { state: TransitionState }) => void;
 }
 
-export const useTransition: (
-  options?: TransitionOptions
-) => [TransitionState, (toEnter?: boolean) => void, () => void];
-
-interface State {
-  state: TransitionState;
-  isMounted: boolean;
-  isEnter: boolean;
+export interface TransitionItemOptions<K> extends Omit<TransitionOptions, 'onChange'> {
+  onChange?: (event: { key: K } & State) => void;
 }
 
-export interface TransitionMapOptions<K> extends Omit<TransitionOptions, 'onChange'> {
-  onChange?: (event: { key: K } & State) => void;
+export interface TransitionMapOptions {
+  singleEnter?: boolean;
 }
 
-export const useTransitionMap: <K>(options?: { singleEnter: boolean }) => {
+export type TransitionResult = [TransitionState, (toEnter?: boolean) => void, () => void];
+
+export interface TransitionMapResult<K> {
   stateMap: Omit<Map<K, State>, 'clear' | 'delete' | 'set'>;
   toggle: (key: K, toEnter?: boolean) => void;
   endTransition: (key: K) => void;
-  setItem: (key: K, options?: TransitionMapOptions<K>) => void;
+  setItem: (key: K, options?: TransitionItemOptions<K>) => void;
   deleteItem: (key: K) => boolean;
-};
+}
+
+export const useTransition: (options?: TransitionOptions) => TransitionResult;
+
+export const useTransitionMap: <K>(options?: TransitionMapOptions) => TransitionMapResult<K>;
 
 export default useTransition;