API reference up.RenderJob

class

A queued render task.

Rendering functions like up.render() or up.submit() return an up.RenderJob. Callers can inspect the job's render options or await its completion.

See render hooks for examples of awaiting rendering completion and how to handle errors.

Example

let job = up.render('.foo', { url: '/users' })
console.log(job.renderOptions.target) // logs ".foo"
console.log(job.renderOptions.url) // logs "/users"
let renderResult = await job // fragments were updated
console.log(renderResult.fragment) // logs the updated fragment
let finalResult = await job.finished // animations are done and cached content was revalidated
console.log(finalResult.fragment) // logs the revalidated fragment