Docs
useExecutionTime

Measure the execution time of a function with the useExecutionTime hook, providing methods to start, stop, and get the elapsed time.

Loading...

Installation

pnpm dlx shadcn@latest add https://usekit.kiron.dev/k/use-execution-time

Usage

"use client"
 
import { useExecutionTime } from "@/hooks/use-execution-time"
 
export function Component() {
  const { runWithTiming, time, isRunning } = useExecutionTime()
 
  return (
    <div style={{ padding: "20px", maxWidth: "600px", margin: "0 auto" }}>
      <button
        onClick={runWithTiming(() => {
          // Simulate a function that takes some time to execute
          for (let i = 0; i < 1e6; i++) {}
          console.log("Function executed")
        })}
      >
        Run Function
      </button>
      <p>Elapsed Time: {time} ms</p>
      <p>Is Running: {isRunning ? "Yes" : "No"}</p>
    </div>
  )
}

API Reference

Return Values

NameTypeDescription
runWithTimingfunctionA function that takes a callback and returns a new function that measures the execution time of the callback.
timenumberThe elapsed time in milliseconds since the last call to runWithTiming.
isRunningbooleanIndicates whether the timer is currently running.