refToCallback.d.ts 714 B

123456789101112131415161718192021222324
  1. import { ReactRef, RefCallback } from './types';
  2. /**
  3. * Unmemoized version of {@link useRefToCallback}
  4. * @see {@link useRefToCallback}
  5. * @param ref
  6. */
  7. export declare function refToCallback<T>(ref: ReactRef<T>): RefCallback<T>;
  8. /**
  9. * Transforms a given `ref` into `callback`.
  10. *
  11. * To transform `callback` into ref use {@link useCallbackRef|useCallbackRef(undefined, callback)}
  12. *
  13. * @param {ReactRef} ref
  14. * @returns {Function}
  15. *
  16. * @see https://github.com/theKashey/use-callback-ref#reftocallback
  17. *
  18. * @example
  19. * const ref = useRef(0);
  20. * const setRef = useRefToCallback(ref);
  21. * 👉 setRef(10);
  22. * ✅ ref.current === 10
  23. */
  24. export declare function useRefToCallback<T>(ref: ReactRef<T>): RefCallback<T>;