Bundleware, Toolbar Script Reference

Last site update 30th October 2026

useGenerate

HookAPI 2

Runs context.generate for this component; see Generation. Unmounting cancels it.

SignatureuseGenerate(): Generation
Take it fromconst { useGenerate } = Bundleware;

Return Value

MemberTypeDescription
busybooleanTrue while a run is in flight.
resultGenerationResult | undefinedThe last completed run's result.
errorstringWhy the last run failed, or ''.
cancelledbooleanTrue when the last run was cancelled, by cancel() or by the browser (for example on navigation).
run(request)Promise<GenerationResult | undefined>Starts a run, superseding any in flight. Resolves undefined if it was superseded, cancelled or failed.
cancel()void

Availability

Applicable versionsAPI 2 and higher
Bundleware0.3.0, build 2026.10.30