Function UseTicker

tsunami/app/hooks.go:191–205

UseTicker manages a ticker lifecycle within a component. It creates a ticker that calls the provided function at regular intervals. The ticker is automatically stopped on dependency changes or component unmount. This hook must be called within a component context.

(interval time.Duration, tickFn func(), deps []any)

// The ticker is automatically stopped on dependency changes or component unmount.
// This hook must be called within a component context.
func UseTicker(interval time.Duration, tickFn func(), deps []any) {
	UseGoRoutine(func(ctx context.Context) {
		ticker := time.NewTicker(interval)
		defer ticker.Stop()

		for {
			select {
			case <-ctx.Done():
				return
			case <-ticker.C:
				tickFn()
			}
		}
	}, deps)
}

// UseAfter manages a timeout lifecycle within a component.
// It creates a timer that calls the provided function after the specified duration.