Function UseGoRoutine

tsunami/app/hooks.go:147–185

UseGoRoutine manages a goroutine lifecycle within a component. It spawns a new goroutine with the provided function when dependencies change, and automatically cancels the context on dependency changes or component unmount. This hook must be called within a component context.

(fn func(ctx context.Context), deps []any)

// and automatically cancels the context on dependency changes or component unmount.
// This hook must be called within a component context.
func UseGoRoutine(fn func(ctx context.Context), deps []any) {
	rc := engine.GetGlobalRenderContext()
	if rc == nil {
		panic("UseGoRoutine must be called within a component (no context)")
	}

	// Use UseRef to store the cancel function
	cancelRef := UseRef[context.CancelFunc](nil)

	UseEffect(func() func() {
		// Cancel any existing goroutine
		if cancelRef.Current != nil {
			cancelRef.Current()
		}

		// Create new context and start goroutine
		ctx, cancel := context.WithCancel(context.Background())
		cancelRef.Current = cancel

		componentName := "unknown"
		if rc.Comp != nil && rc.Comp.Elem != nil {
			componentName = rc.Comp.Elem.Tag
		}

		go func() {
			defer func() {
				util.PanicHandler(fmt.Sprintf("UseGoRoutine in component '%s'", componentName), recover())
			}()
			fn(ctx)
		}()

		// Return cleanup function that cancels the context
		return func() {
			if cancel != nil {
				cancel()
			}
		}
	}, deps)
}

// UseTicker manages a ticker lifecycle within a component.
// It creates a ticker that calls the provided function at regular intervals.