Skip to main content
Version: 5.0.2

useWorker

About​

Worker hook for React.


Installation​

npm install --save rooks

Importing the hook​

import { useWorker } from 'rooks';

Usage​


function Demo() {
const [value, setValue] = useState(0);
const [error, setError] = useState(null);
const worker = useWorker("/worker.js", {
onMessage: e => {
console.log("message received from worker");
console.log(e.data);
setValue(e.data);
},
onMessageError: e => {
console.log(e);
}
});
return value;
}

const rootElement = document.getElementById("root");

ReactDOM.render(<Demo />, rootElement);

Arguments​

ArgumentsTypeDescriptionDefault value
scriptPathstringPath to the script file that a new Worker is to be created withundefined
optionsObjectOptions object within which onMessage and onMessageError options can be passed to communicate with the worker{onMessage: () => {},,onMessageError: () => {}}

Returned Object​

The worker instance is returned.

Join Bhargav's discord server​

You can click on the floating discord icon at the bottom right of the screen and talk to us in our server.