Worklet

open class Worklet<in M : WorkletModule>(source)

The Worklet interface is a lightweight version of Web Workers and gives developers access to low-level parts of the rendering pipeline. Available only in secure contexts.

MDN Reference

Inheritors

AudioWorklet

Functions

addModule

inline suspend fun <M : WorkletModule> Worklet<M>.addModule(module: M)

inline suspend fun <M : WorkletModule> Worklet<M>.addModule(module: M, options: WorkletOptions)

inline suspend fun <M : WorkletModule> Worklet<M>.addModule(moduleURL: String)

inline suspend fun <M : WorkletModule> Worklet<M>.addModule(moduleURL: URL)

inline suspend fun <M : WorkletModule> Worklet<M>.addModule(moduleURL: String, options: WorkletOptions)

inline suspend fun <M : WorkletModule> Worklet<M>.addModule(moduleURL: URL, options: WorkletOptions)

The addModule() method of the Worklet interface loads the module in the given JavaScript file and adds it to the current Worklet.

addModuleAsync

external fun addModuleAsync(module: M, options: WorkletOptions = definedExternally): Promise<Void>

external fun addModuleAsync(moduleURL: String, options: WorkletOptions = definedExternally): Promise<Void>

external fun addModuleAsync(moduleURL: URL, options: WorkletOptions = definedExternally): Promise<Void>

The addModule() method of the Worklet interface loads the module in the given JavaScript file and adds it to the current Worklet.