Aff.Workers.Dedicated

new :: forall e. String -> Aff (worker :: WORKER | e) Dedicated

Returns a new Worker object. scriptURL will be fetched and executed in the background, creating a new global environment for which worker represents the communication channel.

new' :: forall e. String -> Options -> Aff (worker :: WORKER | e) Dedicated

Returns a new Worker object. scriptURL will be fetched and executed in the background, creating a new global environment for which worker represents the communication channel. options can be used to define the name of that global environment via the name option, primarily for debugging purposes. It can also ensure this new global environment supports JavaScript modules (specify type: "module"), and if that is specified, can also be used to specify how scriptURL is fetched through the credentials option

terminate :: forall e. Dedicated -> Aff (worker :: WORKER | e) Unit

Aborts worker’s associated global environment.

onMessage :: forall msg e' e. Dedicated -> (msg -> Eff e' Unit) -> Aff (worker :: WORKER | e) Unit

Event handler for the message event

onMessageError :: forall e' e. Dedicated -> (Error -> Eff e' Unit) -> Aff (worker :: WORKER | e) Unit

Event handler for the messageError event

data WorkerType

Constructors

• Classic
• Module

Instances

• Show WorkerType
• Read WorkerType

data WORKER :: Effect

type Options = { name :: String, requestCredentials :: Credentials, workerType :: WorkerType }

newtype Navigator

Instances

• Generic Navigator
• Show Navigator

newtype Location

Instances

• Generic Location
• Show Location

data Credentials

Constructors

• Omit
• SameOrigin
• Include

Instances

• Show Credentials
• Read Credentials

postMessage' :: forall channel transfer msg e. Channel channel => channel -> msg -> Array transfer -> Aff (exception :: EXCEPTION, worker :: WORKER | e) Unit

Clones message and transmits it to the port object associated with dedicatedportGlobal.transfer can be passed as a list of objects that are to be transferred rather than cloned.

postMessage :: forall channel msg e. Channel channel => channel -> msg -> Aff (exception :: EXCEPTION, worker :: WORKER | e) Unit

Clones message and transmits it to the Worker object.

onError :: forall worker e' e. AbstractWorker worker => worker -> (Error -> Eff e' Unit) -> Aff (worker :: WORKER | e) Unit

Event handler for the error event.

data Dedicated :: Type

Instances

• AbstractWorker Dedicated
• Channel Dedicated