tencent cloud

Tencent Cloud Super App as a Service

Release Notes and Announcements
Announcement: Tencent Cloud Mini Program Platform Renamed to Tencent Cloud Super App as a Service on January 2, 2025
Console Updates
Android SDK Updates
iOS SDK Updates
Flutter SDK Updates
IDE Updates
Base Library Updates
Product Introduction
Overview
Strengths
Use Cases
Purchase Guide
Billing Overview
Pay-As-You-Go Billing
Renewal Guide
Service Suspension Instructions
Getting Started
Plan Management
Overview
Console Account Management
Storage Configuration
Acceleration Configuration
Branding Configurations
Platform Features
Console Login
Users and Permission System
Mini Program Management
Mini Game Management
Superapp Management
Commercialization
Platform Management
User Management
Team Management
Operations Management
Security Center
Code Integration Guide
Getting Demo and SDK
Android
iOS
Flutter
Superapp Server
GUID Generation Rules
Mini Program Development Guide
Mini Program Introduction and Development Environment
Mini Program Code Composition
Guide
Framework
Components
API
Server Backend
JS SDK
Base Library
IDE Operation Instructions
Mini Game Development Guide
Guide
API
Server Backend
Practice Tutorial
Mini Program Login Practical Tutorial
Mini Program Subscription Message Practical Tutorial
Payment Practical Tutorial
Ad Integration Practical Tutorial
Mini Game Subscription Message Practical Tutorial
API Documentation
History
Introduction
API Category
Making API Requests
Operation Management APIs
User Management APIs
Team Management APIs
Sensitive API-Related APIs
Role Management APIs
Platform Management APIs
Other Console APIs
Mini Program or Mini Game APIs
Management-Sensitive APIs
Global Domain Management APIs
Superapp APIs
Data Types
Agreements
Service Level Agreement
Data Processing and Security Agreement
SDK Privacy Policy Module
SDK Data Processing and Security Agreement Module

Worker

PDF
Focus Mode
Font Size
Last updated: 2025-02-24 17:10:42

wx.CreateWorker

wx.createWorker(string scriptPath)

Feature description:Creates a worker thread.
Parameter:string scriptPath. The absolute path to the worker’s entry file.
Return value: Worker.A worker object.
Notes:
Before using the API, you need to go to the game.json file, and configure the workers field, which indicates the worker code root directory.
scriptPath should be the absolute path to the entry file and should not start with /.
Currently, only one worker can be created at a time. Before creating another worker, you must call Worker.terminate.
Example:
// Create a normal worker
const worker = wx.createWorker('workers/index.js') // Specify the worker's entry file absolute path

worker.onMessage(function (res) {
console.log(res)
})

worker.postMessage({
msg: 'hello worker'
})

worker.terminate()

Worker

Worker instance, which can be obtained in the main thread via wx.createWorker , or in the worker thread via the global variable worker.

Property

Object env.The environment variables within the worker.
Property
Type
Description
USER_DATA_PATH
string
The path to the user directory in the file system (local path).

Worker.onMessage

Worker.onMessage(function listener)

Feature description:Listens for messages sent from the main thread/worker thread to the current thread.
Parameter: function listener. listener for the event where the main/Worker thread sends messages to the current thread.
ParameterObject res
Property
Type
Description
message
Object
Messages sent by the main/Worker thread to the current thread.

Worker.postMessage

Worker.postMessage(Object message)

Feature description:Messages sent to the main/worker thread.
Parameter: Object message. Messages to be sent.
Example:
In the worker thread
worker.postMessage({
msg: 'hello from worker'
})
In the main thread
const worker = wx.createWorker('workers/request/index.js')
worker.postMessage({
msg: 'hello from main'
})

Woker.terminate

Worker.terminate()

Feature description:Ends the current worker thread. This can only be called on the worker object in the main thread.




Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback