46 Star 173 Fork 4.7K

OpenHarmony/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
.gitee
api
@internal
ability
advertising
app
application
arkui
bundle
bundleManager
common
commonEvent
config
continuation
data/rdb
device-define
form
global
graphics3d
multimedia
notification
security
syscapCheck
tag
wantAgent
@ohos.InputMethodExtensionAbility.d.ts
@ohos.InputMethodExtensionContext.d.ts
@ohos.InputMethodSubtype.d.ts
@ohos.PiPWindow.d.ts
@ohos.UiTest.d.ts
@ohos.WallpaperExtensionAbility.d.ts
@ohos.WorkSchedulerExtensionAbility.d.ts
@ohos.ability.ability.d.ts
@ohos.ability.dataUriUtils.d.ts
@ohos.ability.errorCode.d.ts
@ohos.ability.featureAbility.d.ts
@ohos.ability.particleAbility.d.ts
@ohos.ability.screenLockFileManager.d.ts
@ohos.ability.wantConstant.d.ts
@ohos.abilityAccessCtrl.d.ts
@ohos.accessibility.GesturePath.d.ts
@ohos.accessibility.GesturePoint.d.ts
@ohos.accessibility.config.d.ts
@ohos.accessibility.d.ts
@ohos.account.appAccount.d.ts
@ohos.account.distributedAccount.d.ts
@ohos.account.osAccount.d.ts
@ohos.advertising.AdComponent.d.ets
@ohos.advertising.AdsServiceExtensionAbility.d.ts
@ohos.advertising.AutoAdComponent.d.ets
@ohos.advertising.d.ts
@ohos.ai.intelligentVoice.d.ts
@ohos.ai.mindSporeLite.d.ts
@ohos.animation.windowAnimationManager.d.ts
@ohos.animator.d.ts
@ohos.app.ability.Ability.d.ts
@ohos.app.ability.AbilityConstant.d.ts
@ohos.app.ability.AbilityLifecycleCallback.d.ts
@ohos.app.ability.AbilityStage.d.ts
@ohos.app.ability.ActionExtensionAbility.d.ts
@ohos.app.ability.AppServiceExtensionAbility.d.ts
@ohos.app.ability.ApplicationStateChangeCallback.d.ts
@ohos.app.ability.AtomicServiceOptions.d.ts
@ohos.app.ability.AutoFillExtensionAbility.d.ts
@ohos.app.ability.ChildProcess.d.ts
@ohos.app.ability.ChildProcessArgs.d.ts
@ohos.app.ability.ChildProcessOptions.d.ts
@ohos.app.ability.CompletionHandler.d.ts
@ohos.app.ability.CompletionHandlerForAtomicService.d.ts
@ohos.app.ability.Configuration.d.ts
@ohos.app.ability.ConfigurationConstant.d.ts
@ohos.app.ability.DriverExtensionAbility.d.ts
@ohos.app.ability.EmbeddableUIAbility.d.ts
@ohos.app.ability.EmbeddedUIExtensionAbility.d.ts
@ohos.app.ability.EnvironmentCallback.d.ts
@ohos.app.ability.ExtensionAbility.d.ts
@ohos.app.ability.FenceExtensionAbility.d.ts
@ohos.app.ability.FenceExtensionContext.d.ts
@ohos.app.ability.InsightIntentContext.d.ts
@ohos.app.ability.InsightIntentDecorator.d.ts
@ohos.app.ability.InsightIntentEntryExecutor.d.ts
@ohos.app.ability.InsightIntentExecutor.d.ts
@ohos.app.ability.MediaControlExtensionAbility.d.ts
@ohos.app.ability.OpenLinkOptions.d.ts
@ohos.app.ability.PhotoEditorExtensionAbility.d.ts
@ohos.app.ability.PrintExtensionAbility.d.ts
@ohos.app.ability.ServiceExtensionAbility.d.ts
@ohos.app.ability.ShareExtensionAbility.d.ts
@ohos.app.ability.StartOptions.d.ts
@ohos.app.ability.UIAbility.d.ts
@ohos.app.ability.UIExtensionAbility.d.ts
@ohos.app.ability.UIExtensionContentSession.d.ts
@ohos.app.ability.UIServiceExtensionAbility.d.ts
@ohos.app.ability.UserAuthExtensionAbility.d.ts
@ohos.app.ability.VpnExtensionAbility.d.ts
@ohos.app.ability.Want.d.ts
@ohos.app.ability.abilityDelegatorRegistry.d.ts
@ohos.app.ability.abilityManager.d.ts
@ohos.app.ability.appManager.d.ts
@ohos.app.ability.appRecovery.d.ts
@ohos.app.ability.application.d.ts
@ohos.app.ability.autoFillManager.d.ts
@ohos.app.ability.autoStartupManager.d.ts
@ohos.app.ability.childProcessManager.d.ts
@ohos.app.ability.common.d.ts
@ohos.app.ability.contextConstant.d.ts
@ohos.app.ability.continueManager.d.ts
@ohos.app.ability.dataUriUtils.d.ts
@ohos.app.ability.dialogRequest.d.ts
@ohos.app.ability.dialogSession.d.ts
@ohos.app.ability.errorManager.d.ts
@ohos.app.ability.insightIntent.d.ts
@ohos.app.ability.insightIntentDriver.d.ts
@ohos.app.ability.kioskManager.d.ts
@ohos.app.ability.missionManager.d.ts
@ohos.app.ability.quickFixManager.d.ts
@ohos.app.ability.sendableContextManager.d.ets
@ohos.app.ability.wantAgent.d.ts
@ohos.app.ability.wantConstant.d.ts
@ohos.app.appstartup.StartupConfig.d.ts
@ohos.app.appstartup.StartupConfigEntry.d.ts
@ohos.app.appstartup.StartupListener.d.ts
@ohos.app.appstartup.StartupTask.d.ets
@ohos.app.appstartup.startupManager.d.ts
@ohos.app.businessAbilityRouter.d.ts
@ohos.app.form.FormEditExtensionAbility.d.ts
@ohos.app.form.FormExtensionAbility.d.ts
@ohos.app.form.LiveFormExtensionAbility.d.ts
@ohos.app.form.formAgent.d.ts
@ohos.app.form.formBindingData.d.ts
@ohos.app.form.formHost.d.ts
@ohos.app.form.formInfo.d.ts
@ohos.app.form.formObserver.d.ts
@ohos.app.form.formProvider.d.ts
@ohos.application.AccessibilityExtensionAbility.d.ts
@ohos.application.BackupExtensionAbility.d.ts
@ohos.application.Configuration.d.ts
@ohos.application.ConfigurationConstant.d.ts
@ohos.application.DataShareExtensionAbility.d.ts
@ohos.application.DistributedExtensionAbility.d.ts
@ohos.application.DistributedExtensionContext.d.ts
@ohos.application.StaticSubscriberExtensionAbility.d.ts
@ohos.application.StaticSubscriberExtensionContext.d.ts
@ohos.application.Want.d.ts
@ohos.application.WindowExtensionAbility.d.ts
@ohos.application.abilityDelegatorRegistry.d.ts
@ohos.application.abilityManager.d.ts
@ohos.application.appManager.d.ts
@ohos.application.formBindingData.d.ts
@ohos.application.formError.d.ts
@ohos.application.formHost.d.ts
@ohos.application.formInfo.d.ts
@ohos.application.formProvider.d.ts
@ohos.application.missionManager.d.ts
@ohos.application.testRunner.d.ts
@ohos.application.uriPermissionManager.d.ts
@ohos.arkui.ArcAlphabetIndexer.d.ts
@ohos.arkui.ArcList.d.ts
@ohos.arkui.ArcScrollBar.d.ts
@ohos.arkui.ArcSwiper.d.ts
@ohos.arkui.Prefetcher.d.ts
@ohos.arkui.StateManagement.d.ts
@ohos.arkui.UIContext.d.ts
@ohos.arkui.advanced.ArcButton.d.ets
@ohos.arkui.advanced.ArcSlider.d.ets
@ohos.arkui.advanced.Chip.d.ets
@ohos.arkui.advanced.ChipGroup.d.ets
@ohos.arkui.advanced.ComposeListItem.d.ets
@ohos.arkui.advanced.ComposeTitleBar.d.ets
@ohos.arkui.advanced.Counter.d.ets
@ohos.arkui.advanced.Dialog.d.ets
@ohos.arkui.advanced.DialogV2.d.ets
@ohos.arkui.advanced.DownloadFileButton.d.ets
@ohos.arkui.advanced.EditableTitleBar.d.ets
@ohos.arkui.advanced.ExceptionPrompt.d.ets
@ohos.arkui.advanced.Filter.d.ets
@ohos.arkui.advanced.FoldSplitContainer.d.ets
@ohos.arkui.advanced.FormMenu.d.ets
@ohos.arkui.advanced.FullScreenLaunchComponent.d.ets
@ohos.arkui.advanced.GridObjectSortComponent.d.ets
@ohos.arkui.advanced.InnerFullScreenLaunchComponent.d.ets
@ohos.arkui.advanced.MultiNavigation.d.ets
@ohos.arkui.advanced.Popup.d.ets
@ohos.arkui.advanced.ProgressButton.d.ets
@ohos.arkui.advanced.ProgressButtonV2.d.ets
@ohos.arkui.advanced.SegmentButton.d.ets
@ohos.arkui.advanced.SegmentButtonV2.d.ets
@ohos.arkui.advanced.SelectTitleBar.d.ets
@ohos.arkui.advanced.SelectionMenu.d.ets
@ohos.arkui.advanced.SplitLayout.d.ets
@ohos.arkui.advanced.SubHeader.d.ets
@ohos.arkui.advanced.SubHeaderV2.d.ets
@ohos.arkui.advanced.SwipeRefresher.d.ets
@ohos.arkui.advanced.TabTitleBar.d.ets
@ohos.arkui.advanced.ToolBar.d.ets
@ohos.arkui.advanced.ToolBarV2.d.ets
@ohos.arkui.advanced.TreeView.d.ets
@ohos.arkui.component.d.ets
@ohos.arkui.componentSnapshot.d.ts
@ohos.arkui.componentUtils.d.ts
@ohos.arkui.dragController.d.ts
@ohos.arkui.drawableDescriptor.d.ts
@ohos.arkui.inspector.d.ts
@ohos.arkui.modifier.d.ts
@ohos.arkui.node.d.ts
@ohos.arkui.observer.d.ts
@ohos.arkui.performanceMonitor.d.ts
@ohos.arkui.shape.d.ts
@ohos.arkui.stateManagement.d.ets
@ohos.arkui.theme.d.ts
@ohos.arkui.uiExtension.d.ts
@ohos.atomicservice.AtomicServiceNavigation.d.ets
@ohos.atomicservice.AtomicServiceSearch.d.ets
@ohos.atomicservice.AtomicServiceTabs.d.ets
@ohos.atomicservice.AtomicServiceWeb.d.ets
@ohos.atomicservice.HalfScreenLaunchComponent.d.ets
@ohos.atomicservice.InterstitialDialogAction.d.ets
@ohos.atomicservice.NavPushPathHelper.d.ets
@ohos.backgroundTaskManager.d.ts
@ohos.base.d.ets
@ohos.base.d.ts
@ohos.batteryInfo.d.ets
@ohos.batteryInfo.d.ts
@ohos.batteryStatistics.d.ts
@ohos.bluetooth.a2dp.d.ts
@ohos.bluetooth.access.d.ts
@ohos.bluetooth.baseProfile.d.ts
@ohos.bluetooth.ble.d.ts
@ohos.bluetooth.connection.d.ts
@ohos.bluetooth.constant.d.ts
@ohos.bluetooth.d.ts
@ohos.bluetooth.hfp.d.ts
@ohos.bluetooth.hid.d.ts
@ohos.bluetooth.map.d.ts
@ohos.bluetooth.opp.d.ts
@ohos.bluetooth.pan.d.ts
@ohos.bluetooth.pbap.d.ts
@ohos.bluetooth.socket.d.ts
@ohos.bluetooth.wearDetection.d.ts
@ohos.bluetoothManager.d.ts
@ohos.brightness.d.ts
@ohos.buffer.d.ts
@ohos.bundle.appControl.d.ts
@ohos.bundle.appDomainVerify.d.ts
@ohos.bundle.bundleManager.d.ts
@ohos.bundle.bundleMonitor.d.ts
@ohos.bundle.bundleResourceManager.d.ts
@ohos.bundle.d.ts
@ohos.bundle.defaultAppManager.d.ts
@ohos.bundle.distributedBundleManager.d.ts
@ohos.bundle.freeInstall.d.ts
@ohos.bundle.innerBundleManager.d.ts
@ohos.bundle.installer.d.ts
@ohos.bundle.launcherBundleManager.d.ts
@ohos.bundle.overlay.d.ts
@ohos.bundle.shortcutManager.d.ts
@ohos.bundleState.d.ts
@ohos.bytrace.d.ts
@ohos.calendarManager.d.ts
@ohos.charger.d.ts
@ohos.commonEvent.d.ts
@ohos.commonEventManager.d.ts
@ohos.configPolicy.d.ts
@ohos.connectedTag.d.ts
@ohos.contact.d.ts
@ohos.continuation.continuationManager.d.ts
@ohos.convertxml.d.ts
@ohos.cooperate.d.ts
@ohos.curves.d.ts
@ohos.customization.customConfig.d.ts
@ohos.data.DataShareResultSet.d.ts
@ohos.data.UdmfComponents.d.ets
@ohos.data.ValuesBucket.d.ts
@ohos.data.cloudData.d.ts
@ohos.data.cloudExtension.d.ts
@ohos.data.commonType.d.ts
@ohos.data.dataAbility.d.ts
@ohos.data.dataShare.d.ts
@ohos.data.dataSharePredicates.d.ts
@ohos.data.distributedData.d.ts
@ohos.data.distributedDataObject.d.ts
@ohos.data.distributedKVStore.d.ts
@ohos.data.intelligence.d.ts
@ohos.data.preferences.d.ts
@ohos.data.rdb.d.ts
@ohos.data.relationalStore.d.ts
@ohos.data.sendablePreferences.d.ets
@ohos.data.sendableRelationalStore.d.ets
@ohos.data.storage.d.ts
@ohos.data.unifiedDataChannel.d.ts
@ohos.data.uniformDataStruct.d.ts
@ohos.data.uniformTypeDescriptor.d.ts
@ohos.deviceAttest.d.ts
@ohos.deviceInfo.d.ets
@ohos.deviceInfo.d.ts
@ohos.deviceStatus.dragInteraction.d.ts
@ohos.display.d.ts
@ohos.distributedBundle.d.ts
@ohos.distributedDeviceManager.d.ts
@ohos.distributedHardware.deviceManager.d.ts
@ohos.distributedHardware.hardwareManager.d.ts
@ohos.distributedHardware.mechanicManager.d.ts
@ohos.distributedMissionManager.d.ts
@ohos.distributedsched.abilityConnectionManager.d.ts
@ohos.distributedsched.linkEnhance.d.ts
@ohos.distributedsched.proxyChannelManager.d.ts
@ohos.dlpPermission.d.ts
@ohos.document.d.ts
@ohos.driver.deviceManager.d.ts
@ohos.effectKit.d.ts
@ohos.enterprise.EnterpriseAdminExtensionAbility.d.ts
@ohos.enterprise.accountManager.d.ts
@ohos.enterprise.adminManager.d.ts
@ohos.enterprise.applicationManager.d.ts
@ohos.enterprise.bluetoothManager.d.ts
@ohos.enterprise.browser.d.ts
@ohos.enterprise.bundleManager.d.ts
@ohos.enterprise.dateTimeManager.d.ts
@ohos.enterprise.deviceControl.d.ts
@ohos.enterprise.deviceInfo.d.ts
@ohos.enterprise.deviceSettings.d.ts
@ohos.enterprise.locationManager.d.ts
@ohos.enterprise.networkManager.d.ts
@ohos.enterprise.restrictions.d.ts
@ohos.enterprise.securityManager.d.ts
@ohos.enterprise.systemManager.d.ts
@ohos.enterprise.telephonyManager.d.ts
@ohos.enterprise.usbManager.d.ts
@ohos.enterprise.wifiManager.d.ts
@ohos.events.emitter.d.ts
@ohos.fastbuffer.d.ts
@ohos.faultLogger.d.ts
@ohos.file.AlbumPickerComponent.d.ets
@ohos.file.BackupExtensionContext.d.ts
@ohos.file.PhotoPickerComponent.d.ets
@ohos.file.RecentPhotoComponent.d.ets
@ohos.file.backup.d.ts
@ohos.file.cloudSync.d.ts
@ohos.file.cloudSyncManager.d.ts
@ohos.file.environment.d.ts
@ohos.file.fileAccess.d.ts
@ohos.file.fileExtensionInfo.d.ts
@ohos.file.fileuri.d.ts
@ohos.file.fs.d.ets
@ohos.file.fs.d.ts
@ohos.file.hash.d.ts
@ohos.file.keyManager.d.ts
@ohos.file.photoAccessHelper.d.ts
@ohos.file.picker.d.ts
@ohos.file.recent.d.ts
@ohos.file.securityLabel.d.ts
@ohos.file.sendablePhotoAccessHelper.d.ets
@ohos.file.statvfs.d.ts
@ohos.file.storageStatistics.d.ts
@ohos.file.trash.d.ts
@ohos.file.volumeManager.d.ts
@ohos.fileio.d.ts
@ohos.filemanagement.userFileManager.d.ts
@ohos.fileshare.d.ts
@ohos.font.d.ts
@ohos.fontManager.d.ts
@ohos.geoLocationManager.d.ts
@ohos.geolocation.d.ts
@ohos.graphics.colorSpaceManager.d.ts
@ohos.graphics.common2D.d.ts
@ohos.graphics.displaySync.d.ts
@ohos.graphics.drawing.d.ts
@ohos.graphics.hdrCapability.d.ts
@ohos.graphics.scene.d.ts
@ohos.graphics.sendableColorSpaceManager.d.ets
@ohos.graphics.text.d.ts
@ohos.graphics.uiEffect.d.ts
@ohos.hiAppEvent.d.ts
@ohos.hiSysEvent.d.ts
@ohos.hiTraceChain.d.ts
@ohos.hiTraceMeter.d.ts
@ohos.hichecker.d.ts
@ohos.hidebug.d.ts
@ohos.hilog.d.ts
@ohos.hiviewdfx.hiAppEvent.d.ts
@ohos.hiviewdfx.jsLeakWatcher.d.ts
@ohos.i18n.d.ts
@ohos.identifier.oaid.d.ts
@ohos.inputMethod.Panel.d.ts
@ohos.inputMethod.d.ts
@ohos.inputMethodEngine.d.ts
@ohos.inputMethodList.d.ets
@ohos.intl.d.ts
@ohos.logLibrary.d.ts
@ohos.matrix4.d.ets
@ohos.matrix4.d.ts
@ohos.measure.d.ts
@ohos.mediaquery.d.ets
@ohos.mediaquery.d.ts
@ohos.multimedia.audio.d.ts
@ohos.multimedia.audioHaptic.d.ts
@ohos.multimedia.avCastPicker.d.ets
@ohos.multimedia.avCastPickerParam.d.ts
@ohos.multimedia.avInputCastPicker.d.ets
@ohos.multimedia.avVolumePanel.d.ets
@ohos.multimedia.avsession.d.ts
@ohos.multimedia.camera.d.ts
@ohos.multimedia.cameraPicker.d.ts
@ohos.multimedia.drm.d.ts
@ohos.multimedia.image.d.ts
@ohos.multimedia.media.d.ts
@ohos.multimedia.movingphotoview.d.ts
@ohos.multimedia.sendableImage.d.ets
@ohos.multimedia.systemSoundManager.d.ts
@ohos.multimedia.videoProcessingEngine.d.ts
@ohos.multimodalAwareness.deviceStatus.d.ts
@ohos.multimodalAwareness.metadataBinding.d.ts
@ohos.multimodalAwareness.motion.d.ts
@ohos.multimodalAwareness.onScreen.d.ts
@ohos.multimodalAwareness.userStatus.d.ts
@ohos.multimodalInput.gestureEvent.d.ts
@ohos.multimodalInput.infraredEmitter.d.ts
@ohos.multimodalInput.inputConsumer.d.ts
@ohos.multimodalInput.inputDevice.d.ts
@ohos.multimodalInput.inputDeviceCooperate.d.ts
@ohos.multimodalInput.inputEvent.d.ts
@ohos.multimodalInput.inputEventClient.d.ts
@ohos.multimodalInput.inputMonitor.d.ts
@ohos.multimodalInput.intentionCode.d.ts
@ohos.multimodalInput.keyCode.d.ts
@ohos.multimodalInput.keyEvent.d.ts
@ohos.multimodalInput.mouseEvent.d.ts
@ohos.multimodalInput.pointer.d.ts
@ohos.multimodalInput.shortKey.d.ts
@ohos.multimodalInput.touchEvent.d.ts
@ohos.net.connection.d.ts
@ohos.net.eap.d.ts
@ohos.net.ethernet.d.ts
@ohos.net.http.d.ts
@ohos.net.mdns.d.ts
@ohos.net.netFirewall.d.ts
@ohos.net.networkSecurity.d.ts
@ohos.net.policy.d.ts
@ohos.net.sharing.d.ts
@ohos.net.socket.d.ts
@ohos.net.statistics.d.ts
@ohos.net.vpn.d.ts
@ohos.net.vpnExtension.d.ts
@ohos.net.webSocket.d.ts
@ohos.nfc.cardEmulation.d.ts
@ohos.nfc.controller.d.ts
@ohos.nfc.tag.d.ts
@ohos.notification.d.ts
@ohos.notificationManager.d.ts
@ohos.notificationSubscribe.d.ts
@ohos.pasteboard.d.ts
@ohos.pluginComponent.d.ts
@ohos.power.d.ts
@ohos.print.d.ts
@ohos.privacyManager.d.ts
@ohos.process.d.ts
@ohos.prompt.d.ets
@ohos.prompt.d.ts
@ohos.promptAction.d.ts
@ohos.reminderAgent.d.ts
@ohos.reminderAgentManager.d.ts
@ohos.request.cacheDownload.d.ts
@ohos.request.d.ts
@ohos.resourceManager.d.ts
@ohos.resourceschedule.backgroundProcessManager.d.ts
@ohos.resourceschedule.backgroundTaskManager.d.ts
@ohos.resourceschedule.deviceStandby.d.ts
@ohos.resourceschedule.systemload.d.ts
@ohos.resourceschedule.usageStatistics.d.ts
@ohos.resourceschedule.workScheduler.d.ts
@ohos.router.d.ets
@ohos.router.d.ts
@ohos.rpc.d.ts
@ohos.runningLock.d.ts
@ohos.scan.d.ets
@ohos.screen.d.ts
@ohos.screenLock.d.ts
@ohos.screenshot.d.ts
@ohos.secureElement.d.ts
@ohos.security.asset.d.ts
@ohos.security.cert.d.ts
@ohos.security.certManager.d.ts
@ohos.security.certManagerDialog.d.ts
@ohos.security.cryptoFramework.d.ts
@ohos.security.huks.d.ts
@ohos.security.securityGuard.d.ts
@ohos.selectionInput.SelectionExtensionAbility.d.ts
@ohos.selectionInput.SelectionExtensionContext.d.ts
@ohos.selectionInput.SelectionPanel.d.ts
@ohos.selectionInput.selectionManager.d.ts
@ohos.sendableResourceManager.d.ets
@ohos.sensor.d.ts
@ohos.settings.d.ts
@ohos.statfs.d.ts
@ohos.stationary.d.ts
@ohos.systemCapability.d.ts
@ohos.systemDateTime.d.ts
@ohos.systemParameterEnhance.d.ts
@ohos.systemTime.d.ts
@ohos.systemTimer.d.ts
@ohos.systemparameter.d.ts
@ohos.taskpool.d.ts
@ohos.telephony.call.d.ts
@ohos.telephony.data.d.ts
@ohos.telephony.esim.d.ts
@ohos.telephony.observer.d.ts
@ohos.telephony.radio.d.ts
@ohos.telephony.sim.d.ts
@ohos.telephony.sms.d.ts
@ohos.telephony.vcard.d.ts
@ohos.test.PerfTest.d.ts
@ohos.thermal.d.ts
@ohos.transfer.d.ets
@ohos.uiAppearance.d.ts
@ohos.uiExtensionHost.d.ets
@ohos.uiExtensionHost.d.ts
@ohos.update.d.ts
@ohos.uri.d.ts
@ohos.url.d.ts
@ohos.usb.d.ts
@ohos.usbManager.d.ts
@ohos.usbManager.serial.d.ts
@ohos.userIAM.faceAuth.d.ts
@ohos.userIAM.userAccessCtrl.d.ts
@ohos.userIAM.userAuth.d.ts
@ohos.userIAM.userAuthIcon.d.ets
@ohos.util.ArrayList.d.ts
@ohos.util.Deque.d.ts
@ohos.util.HashMap.d.ts
@ohos.util.HashSet.d.ts
@ohos.util.LightWeightMap.d.ts
@ohos.util.LightWeightSet.d.ts
@ohos.util.LinkedList.d.ts
@ohos.util.List.d.ts
@ohos.util.PlainArray.d.ts
@ohos.util.Queue.d.ts
@ohos.util.Stack.d.ts
@ohos.util.TreeMap.d.ts
@ohos.util.TreeSet.d.ts
@ohos.util.Vector.d.ts
@ohos.util.d.ets
@ohos.util.d.ts
@ohos.util.json.d.ts
@ohos.util.stream.d.ts
@ohos.vibrator.d.ts
@ohos.wallpaper.d.ts
@ohos.wantAgent.d.ts
@ohos.web.netErrorList.d.ts
@ohos.web.webview.d.ts
@ohos.wifi.d.ts
@ohos.wifiManager.d.ts
@ohos.wifiManagerExt.d.ts
@ohos.wifiext.d.ts
@ohos.window.d.ts
@ohos.window.floatingBall.d.ts
@ohos.worker.d.ts
@ohos.xml.d.ts
@ohos.zlib.d.ts
@system.app.d.ets
@system.app.d.ts
@system.battery.d.ts
@system.bluetooth.d.ts
@system.brightness.d.ts
@system.cipher.d.ts
@system.configuration.d.ts
@system.device.d.ts
@system.fetch.d.ts
@system.file.d.ts
@system.geolocation.d.ts
@system.mediaquery.d.ets
@system.mediaquery.d.ts
@system.network.d.ts
@system.notification.d.ts
@system.package.d.ts
@system.prompt.d.ets
@system.prompt.d.ts
@system.request.d.ts
@system.router.d.ets
@system.router.d.ts
@system.sensor.d.ts
@system.storage.d.ts
@system.vibrator.d.ts
permissions.d.ts
arkts
build-tools
kits
CODEOWNERS
.gitattributes
.gitignore
BUILD.gn
LICENCE.md
LICENSE
OAT.xml
README.md
README_zh.md
arkui_transformer.py
bundle.json
exists_path.py
interface_config.gni
ohos_copy_ets.py
process_internal.py
process_internal.pydeps
remove_internal.py
remove_internal.pydeps
remove_list.json
克隆/下载
@ohos.worker.d.ts 91.22 KB
一键复制 编辑 原始数据 按行查看 历史
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469
/*
* Copyright (c) 2021 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ArkTS
*/
/**
* @typedef WorkerOptions
* Provides options that can be set for the worker to create.
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* @typedef WorkerOptions
* Provides options that can be set for the worker to create.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* @typedef WorkerOptions
* Provides options that can be set for the Worker instance to create.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
export interface WorkerOptions {
/**
* Mode in which the worker executes the script.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Mode in which the worker executes the script.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Mode in which the Worker instance executes the script. The module type is not supported yet. The default value is classic.
*
* @type { ?('classic' | 'module') }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
type?: 'classic' | 'module';
/**
* Name of the worker.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Name of the worker.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Name of the Worker thread. The default value is undefined.
*
* @type { ?string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
name?: string;
/**
* Whether the worker is shared.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Whether the worker is shared.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Whether sharing of the Worker instance is enabled. Currently, sharing is not supported.
*
* @type { ?boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
shared?: boolean;
/**
* Priority of the Worker thread.
*
* @type { ?ThreadWorkerPriority }
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
priority?: ThreadWorkerPriority;
}
/**
* Enumerates the priorities available for Worker threads. For details about the mappings between priorities and QoS levels, see QoS Level.
*
* @enum { number } ThreadWorkerPriority
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
export enum ThreadWorkerPriority {
/**
* High priority, corresponding to QOS_USER_INITIATED.
*
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
HIGH = 0,
/**
* Medium priority, corresponding to QOS_DEFAULT.
*
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
MEDIUM = 1,
/**
* Low priority, corresponding to QOS_UTILITY.
*
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
LOW = 2,
/**
* Background priority, corresponding to QOS_BACKGROUND.
*
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
IDLE = 3,
/**
* Deadline priority, corresponding to QOS_DEADLINE_REQUEST.
*
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 20
*/
DEADLINE = 4,
/**
* Vip priority, corresponding to QOS_USER_INTERACTIVE.
*
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 20
*/
VIP = 5
}
/**
* @typedef Event
* Defines the event.
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* @typedef Event
* Defines the event.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* @typedef Event
* Defines the event.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
export interface Event {
/**
* Type of the Event.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Type of the Event.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Type of the Event.
*
* @type { string }
* @readonly
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
readonly type: string;
/**
* Timestamp(accurate to millisecond) when the event is created.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Timestamp(accurate to millisecond) when the event is created.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Timestamp (accurate to millisecond) when the event is created. This parameter is not supported yet.
*
* @type { number }
* @readonly
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
readonly timeStamp: number;
}
/**
* Provides detailed information about the exception occurred during worker execution.
* @typedef ErrorEvent
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Provides detailed information about the exception occurred during worker execution.
* @typedef ErrorEvent
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Provides detailed information about the exception that occurs during worker execution. The ErrorEvent class inherits from Event.
* @typedef ErrorEvent
* @extends Event
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
export interface ErrorEvent extends Event {
/**
* Information about the exception.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Information about the exception.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Information about the exception.
*
* @type { string }
* @readonly
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readonly message: string;
/**
* File where the exception is located.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* File where the exception is located.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* File where the exception is located.
*
* @type { string }
* @readonly
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readonly filename: string;
/**
* Number of the line where the exception is located.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Number of the line where the exception is located.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Serial number of the line where the exception is located.
*
* @type { number }
* @readonly
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readonly lineno: number;
/**
* Number of the column where the exception is located.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Number of the column where the exception is located.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Serial number of the column where the exception is located.
*
* @type { number }
* @readonly
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readonly colno: number;
/**
* Type of the exception.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Type of the exception.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Type of the exception.
*
* @type { Object }
* @readonly
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readonly error: Object;
}
/**
* Holds the data transferred between worker threads.
* @typedef MessageEvent<T>
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Holds the data transferred between worker threads.
* @typedef MessageEvent<T>
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Holds the data transferred between worker threads.
* @typedef MessageEvent<T>
* @extends Event
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
export interface MessageEvent<T> extends Event {
/**
* Data transferred when an exception occurs.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Data transferred when an exception occurs.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Data transferred when an exception occurs.
*
* @type { T }
* @readonly
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
readonly data: T;
}
/**
* Saves the data transferred between worker thread and host thread.
* @typedef MessageEvents
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Saves the data transferred between worker thread and host thread.
* @typedef MessageEvents
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Holds the data transferred between Worker threads.
* @typedef MessageEvents
* @extends Event
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
export interface MessageEvents extends Event {
/**
* Data transferred when an exception occurs.
*
* @type { any }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Data transferred when an exception occurs.
*
* @type { any }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Data transferred when an exception occurs.
*
* @type { any }
* @readonly
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readonly data: any;
}
/**
* @typedef PostMessageOptions
* Specifies the object whose ownership need to be transferred during data transfer.
* The object must be ArrayBuffer.
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* @typedef PostMessageOptions
* Specifies the object whose ownership need to be transferred during data transfer.
* The object must be ArrayBuffer.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* @typedef PostMessageOptions
* Defines the object for which the ownership is to be transferred during data transfer. The object must be an ArrayBuffer instance.
* After the ownership is transferred, the object becomes unavailable in the sender and can be used only in the receiver.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
export interface PostMessageOptions {
/**
* ArrayBuffer array used to transfer the ownership.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* ArrayBuffer array used to transfer the ownership.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* ArrayBuffer array used to transfer the ownership. The array cannot be null.
*
* @type { ?Object[] }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
transfer?: Object[];
}
/**
* @typedef EventListener
* Implements event listening.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.WorkerEventListener
*/
export interface EventListener {
/**
* Specifies the callback to invoke.
*
* @param { Event } evt - evt evt Event class for the callback to invoke.
* @returns { void | Promise<void> }
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.WorkerEventListener.(event: Event)
*/
(evt: Event): void | Promise<void>;
}
/**
* @typedef WorkerEventListener
* Implements event listening.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* @typedef WorkerEventListener
* Implements event listening.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* @typedef WorkerEventListener
* Implements event listening.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
export interface WorkerEventListener {
/**
* Specifies the callback function to be invoked.
*
* @param { Event } event - event Event class for the callback to invoke.
* @returns { void | Promise<void> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Specifies the callback function to be invoked.
*
* @param { Event } event - event Event class for the callback to invoke.
* @returns { void | Promise<void> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Specifies the callback function to be invoked.
*
* @param { Event } event - Event class for the callback to invoke.
* @returns { void | Promise<void> }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
(event: Event): void | Promise<void>;
}
/**
* Type of message, only "message" and "messageerror".
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Type of message, only "message" and "messageerror".
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Type of message, only "message" and "messageerror".
*
* @typedef { 'message' | 'messageerror' }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
type MessageType = 'message' | 'messageerror';
/**
* @typedef EventTarget
* Specific event features.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.WorkerEventTarget
*/
export interface EventTarget {
/**
* Adds an event listener to the worker.
*
* @param { string } type - type Type of the event to listen for.
* @param { EventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.WorkerEventTarget.addEventListener
*/
addEventListener(type: string, listener: EventListener): void;
/**
* Dispatches the event defined for the worker.
*
* @param { Event } event - event Event to dispatch.
* @returns { boolean }
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.WorkerEventTarget.dispatchEvent
*/
dispatchEvent(event: Event): boolean;
/**
* Removes an event defined for the worker.
*
* @param { string } type - type Type of the event for which the event listener is removed.
* @param { EventListener } callback - callback Callback of the event listener to remove.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.WorkerEventTarget.removeEventListener
*/
removeEventListener(type: string, callback?: EventListener): void;
/**
* Removes all event listeners for the worker.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.WorkerEventTarget.removeAllListener
*/
removeAllListener(): void;
}
/**
* @typedef WorkerEventTarget
* Specific worker event features.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* @typedef WorkerEventTarget
* Specific worker event features.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* @typedef WorkerEventTarget
* Processes worker listening events.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
export interface WorkerEventTarget {
/**
* Adds an event listener to the worker.
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Adds an event listener to the worker.
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 10
*/
/**
* Adds an event listener to the worker.
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 11
*/
/**
* Adds an event listener for the Worker thread. This API provides the same functionality as on9+.
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
addEventListener(type: string, listener: WorkerEventListener): void;
/**
* Handle the event defined for the worker.
*
* @param { Event } event - event Event to dispatch.
* @returns { boolean }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Handle the event defined for the worker.
*
* @param { Event } event - event Event to dispatch.
* @returns { boolean }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Dispatches the event defined for the Worker thread.
*
* @param { Event } event - event Event to dispatch.
* @returns { boolean }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
dispatchEvent(event: Event): boolean;
/**
* Remove an event defined for the worker.
*
* @param { string } type - type Type of the event for which the event listener is cancelled.
* @param { WorkerEventListener } [callback] - callback Callback of the event listener to remove.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Remove an event defined for the worker.
*
* @param { string } type - type Type of the event for which the event listener is cancelled.
* @param { WorkerEventListener } [callback] - callback Callback of the event listener to remove.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Removes an event listener for the Worker thread. This API provides the same functionality as off9+.
*
* @param { string } type - type Type of the event for which the event listener is to be removed.
* @param { WorkerEventListener } [callback] - callback Callback to invoke when the listener is removed.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
removeEventListener(type: string, callback?: WorkerEventListener): void;
/**
* Remove all event listeners for the worker.
*
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Remove all event listeners for the worker.
*
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Removes all event listeners for the Worker thread.
*
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
removeAllListener(): void;
}
/**
* @typedef WorkerGlobalScope
* Specifies the worker thread running environment, which is isolated from the host thread environment.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.GlobalScope
*/
declare interface WorkerGlobalScope extends EventTarget {
/**
* Worker name specified when there is a new worker.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.GlobalScope.name
*/
readonly name: string;
/**
* The onerror attribute of parentPort specifies
* the event handler to be called when an exception occurs during worker execution.
* The event handler is executed in the worker thread.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.GlobalScope.onerror
*/
onerror?: (ev: ErrorEvent) => void;
/**
* Specify the type attribute for self.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.GlobalScope.self
*/
readonly self: WorkerGlobalScope & typeof globalThis;
}
/**
* The environment Specified in which worker threads run, which is isolated from the host thread environment.
* @typedef GlobalScope
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The environment Specified in which worker threads run, which is isolated from the host thread environment.
* @typedef GlobalScope
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Implements the running environment of the Worker thread. The GlobalScope class inherits from WorkerEventTarget.
* @typedef GlobalScope
* @extends WorkerEventTarget
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
declare interface GlobalScope extends WorkerEventTarget {
/**
* Name of Worker specified when there is a new worker.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Name of Worker specified when there is a new worker.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Worker instance specified when there is a new Worker instance.
*
* @type { string }
* @readonly
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readonly name: string;
/**
* The onerror attribute of parentPort specified.
* the event handler to be called when an exception occurs during worker execution.
* The event handler is executed in the worker thread.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The onerror attribute of parentPort specified.
* the event handler to be called when an exception occurs during worker execution.
* The event handler is executed in the worker thread.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Called when an exception occurs during worker execution. The event handler is executed in the Worker thread.
* In the callback function, the ev type is ErrorEvent, indicating the received abnormal data.
*
* @type { ?function }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
onerror?: (ev: ErrorEvent) => void;
/**
* Specify the type attribute for self.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Specify the type attribute for self.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* GlobalScope itself.
*
* @type { GlobalScope & typeof globalThis }
* @readonly
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
readonly self: GlobalScope & typeof globalThis;
}
/**
* @typedef DedicatedWorkerGlobalScope
* Specifies the worker thread running environment, which is isolated from the host thread environment
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorkerGlobalScope
*/
export interface DedicatedWorkerGlobalScope extends WorkerGlobalScope {
/**
* The onmessage attribute of parentPort specifies the event handler
* to be called then the worker thread receives a message sent by
* the host thread through worker postMessage.
* The event handler is executed in the worker thread.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorkerGlobalScope.onmessage
*/
onmessage?: (this: DedicatedWorkerGlobalScope, ev: MessageEvent) => void;
/**
* The onmessage attribute of parentPort specifies the event handler
* to be called then the worker receives a message that cannot be deserialized.
* The event handler is executed in the worker thread.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorkerGlobalScope.onmessageerror
*/
onmessageerror?: (this: DedicatedWorkerGlobalScope, ev: MessageEvent) => void;
/**
* Close the worker thread to stop the worker from receiving messages
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorkerGlobalScope.close
*/
close(): void;
/**
* Send a message to be host thread from the worker
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { Transferable[] } transfer - transfer array cannot contain null.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorkerGlobalScope.postMessage
*/
postMessage(messageObject: Object, transfer: Transferable[]): void;
/**
* Send a message to be host thread from the worker
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { PostMessageOptions } [options] - options Option can be set for postmessage.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorkerGlobalScope.postMessage
*/
postMessage(messageObject: Object, options?: PostMessageOptions): void;
/**
* Send a message to host thread from the worker
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { ArrayBuffer[] } transfer - transfer array cannot contain null.
* @syscap SystemCapability.Utils.Lang
* @since 9
* @deprecated since 9
*/
postMessage(messageObject: Object, transfer: ArrayBuffer[]): void;
}
/**
* Specifies the thread-worker running environment, which is isolated from the host-thread environment
* @typedef ThreadWorkerGlobalScope
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Specifies the thread-worker running environment, which is isolated from the host-thread environment
* @typedef ThreadWorkerGlobalScope
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Implements communication between the Worker thread and the host thread. The postMessage API is used to send messages
* to the host thread, and the close API is used to terminate the Worker thread. The ThreadWorkerGlobalScope class inherits from GlobalScope9+.
* @typedef ThreadWorkerGlobalScope
* @extends GlobalScope
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
export interface ThreadWorkerGlobalScope extends GlobalScope {
/**
* The onmessage attribute of parentPort specifies the event handler
* to be called then the worker thread receives a message sent by
* the host thread through worker postMessage.
* The event handler is executed in the worker thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The onmessage attribute of parentPort specifies the event handler
* to be called then the worker thread receives a message sent by
* the host thread through worker postMessage.
* The event handler is executed in the worker thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Called when the Worker thread receives a message sent by the host thread through postMessage.
* The event handler is executed in the Worker thread. In the callback function, this indicates the caller's
* ThreadWorkerGlobalScope, and the ev type is MessageEvents, indicating the received message data.
*
* @type { ?function }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
onmessage?: (this: ThreadWorkerGlobalScope, ev: MessageEvents) => void;
/**
* The onmessage attribute of parentPort specifies the event handler
* to be called then the worker receives a message that cannot be deserialized.
* The event handler is executed in the worker thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The onmessage attribute of parentPort specifies the event handler
* to be called then the worker receives a message that cannot be deserialized.
* The event handler is executed in the worker thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Called when the Worker thread receives a message that cannot be deserialized. The event handler is executed
* in the Worker thread. In the callback function, this indicates the caller's ThreadWorkerGlobalScope,
* and the ev type is MessageEvents, indicating the received message data.
*
* @type { ?function }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
onmessageerror?: (this: ThreadWorkerGlobalScope, ev: MessageEvents) => void;
/**
* Close the worker thread to stop the worker from receiving messages
*
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Close the worker thread to stop the worker from receiving messages
*
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Terminates the Worker thread to stop it from receiving messages.
*
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
close(): void;
/**
* Send a message to host thread from the worker
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { ArrayBuffer[] } transfer - transfer array cannot contain null.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Send a message to host thread from the worker
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { ArrayBuffer[] } transfer - transfer array cannot contain null.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sends a message from the Worker thread to the host thread by transferring object ownership.
*
* @param { Object } messageObject - Data to be sent to the host thread. The data object must be sequenceable.
* For details about the supported parameter types, see Sequenceable Data Types.
* @param { ArrayBuffer[] } transfer - ArrayBuffer instance holding an array of objects for which the ownership
* is transferred to the host thread. After the transfer, the objects are available only in the host thread. The array cannot be null.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
postMessage(messageObject: Object, transfer: ArrayBuffer[]): void;
/**
* Send a message to be host thread from the worker
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { PostMessageOptions } [options] - options Option can be set for postmessage.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Send a message to be host thread from the worker
*
* @param { Object } messageObject - messageObject Data to be sent to the worker
* @param { PostMessageOptions } [options] - options Option can be set for postmessage.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sends a message from the Worker thread to the host thread by transferring object ownership or copying data.
*
* @param { Object } messageObject - Data to be sent to the host thread. The data object must be sequenceable.
* For details about the supported parameter types, see Sequenceable Data Types.
* @param { PostMessageOptions } [options] - If this parameter is specified, it functions the same as ArrayBuffer[].
* Specifically, the ownership of the objects in the array is transferred to the host thread and becomes unavailable in the Worker thread.
* The objects are available only in the host thread. If this parameter is not specified, the default value undefined is used,
* and information is transferred to the host thread by copying data.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
postMessage(messageObject: Object, options?: PostMessageOptions): void;
/**
* Sends a message from the Worker thread to the host thread. In the message, a sendable object is passed by reference,
* and a non-sendable object is passed by serialization.
*
* @param { Object } message - Data to be sent to the host thread. The data object must be sequenceable or sendable.
* For details about the supported sequenceable types, see Sequenceable Data Types.
* For details about the supported sendable types, see Sendable Data Types.
* @param { ArrayBuffer[] } [transfer] - ArrayBuffer instance holding an array of objects for which the ownership is
* transferred to the host thread. After the transfer, the objects are available only in the host thread.
* The array cannot be null. The default value is an empty array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
postMessageWithSharedSendable(message: Object, transfer?: ArrayBuffer[]): void;
/**
* Send a global call on registered globalCallObject on host side and return the result synchronously
*
* @param { string } instanceName - the exact key used in registration
* @param { string } methodName - a string which is same to the method called on globalCallObject.
* @param { number } timeout - the specific milliseconds that will wait for result to return, between 0 and 5000.
* @param { Object[] } args - the method argument called on registered globalCallObject.
* @returns { Object } Return the result of method if it has a return value, otherwise return void.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200019 - The globalCallObject is not registered.
* @throws { BusinessError } 10200020 - The method to be called is not callable or is an async method or a generator.
* @throws { BusinessError } 10200021 - Waiting for a global call timed out.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 11
*/
/**
* Calls a method of an object registered with the host thread. This API is called by the Worker thread.
* The invoking is synchronous for the Worker thread and asynchronous for the host thread. The return value is transferred through serialization.
*
* @param { string } instanceName - Key used for registration. It is used to search for the object in the host thread.
* @param { string } methodName - Name of the method to call. Note that the method cannot be modified by async or generator,
* or return results asynchronously by using the asynchronous mechanism at the bottom layer. Otherwise, an exception is thrown.
* @param { number } timeout - Maximum duration that the current synchronous invoking waits, in ms.
* The value is an integer ranging from 1 to 5000. The value 0 means that the 5000 ms duration is used.
* @param { Object[] } args - the method argument called on registered globalCallObject.
* @returns { Object } Return the result of method if it has a return value, otherwise return void.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200019 - The globalCallObject is not registered.
* @throws { BusinessError } 10200020 - The method to be called is not callable or is an async method or a generator.
* @throws { BusinessError } 10200021 - The global call exceeds the timeout.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
callGlobalCallObjectMethod(instanceName: string, methodName: string, timeout: number, ...args: Object[]): Object;
}
/**
* The event handler to be called when an exception occurs during worker execution.
*
* @typedef { function } ErrorCallback
* @param { ErrorEvent } err - Error event class, which provides detailed information about the exception occurred during Worker execution.
* @returns { void }
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
type ErrorCallback = (err: ErrorEvent) => void;
/**
* JS cross-thread communication tool
*
* @namespace worker
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* JS cross-thread communication tool
*
* @namespace worker
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* JS cross-thread communication tool
*
* @namespace worker
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
declare namespace worker {
/**
* The ThreadWorker class contains all Worker functions.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The ThreadWorker class contains all Worker functions.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Before using the following APIs, you must create a ThreadWorker instance. The ThreadWorker class inherits from WorkerEventTarget.
*
* @implements WorkerEventTarget
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class ThreadWorker implements WorkerEventTarget {
/**
* Creates a worker instance
*
* @param { string } scriptURL - scriptURL URL of the script to be executed by the worker
* @param { WorkerOptions } [options] - options Options that can be set for the worker
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failed.
* @throws { BusinessError } 10200007 - The worker file path is invalid.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Creates a worker instance
*
* @param { string } scriptURL - scriptURL URL of the script to be executed by the worker
* @param { WorkerOptions } [options] - options Options that can be set for the worker
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failed.
* @throws { BusinessError } 10200007 - The worker file path is invalid.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* A constructor used to create a ThreadWorker instance.
*
* @param { string } scriptURL - URL of the Worker thread file. For details about the rules, see Precautions for File URLs.
* @param { WorkerOptions } [options] - Options that can be set for the Worker instance.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failed.
* @throws { BusinessError } 10200007 - The worker file path is invalid.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor(scriptURL: string, options?: WorkerOptions);
/**
* The onexit attribute of the worker specifies the event handler to be called
* when the worker exits. The handler is executed in the host thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The onexit attribute of the worker specifies the event handler to be called
* when the worker exits. The handler is executed in the host thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Called when the Worker thread exits. The event handler is executed in the host thread. In the callback function,
* the code value is of the number type, where the value 1 indicates abnormal exit and 0 indicates normal exit.
*
* @type { ?function }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
onexit?: (code: number) => void;
/**
* The onerror attribute of the worker specifies the event handler to be called
* when an exception occurs during worker execution.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The onerror attribute of the worker specifies the event handler to be called
* when an exception occurs during worker execution.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Called when an exception occurs during worker execution. The event handler is executed in the host thread.
* In the callback function, the err type is ErrorEvent, indicating the received abnormal data.
*
* @type { ?function }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
onerror?: (err: ErrorEvent) => void;
/**
* Called when an exception occurs within the lifecycle of the Worker thread. The event handler is executed in the host thread.
*
* onerror can capture only exceptions generated by synchronous methods within the onmessage callback.
* It cannot capture exceptions from multithreaded callbacks or modularization-related exceptions.
* Once an exception is captured, the Worker thread will proceed to the destruction process and cannot be used.
*
* onAllErrors can capture global exceptions generated during the onmessage callback, timer callback,
* and file execution of the Worker thread. After an exception is captured by onAllErrors,
* the Worker thread remains alive and can continue to be used. You are advised to use onAllErrors instead of onerror.
*
* @type { ?function }
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 18
*/
onAllErrors?: ErrorCallback;
/**
* The onmessage attribute of the worker specifies the event handler
* to be called then the host thread receives a message created by itself
* and sent by the worker through the parentPort.postMessage.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The onmessage attribute of the worker specifies the event handler
* to be called then the host thread receives a message created by itself
* and sent by the worker through the parentPort.postMessage.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Called when the host thread receives a message sent by the Worker thread through workerPort.postMessage.
* The event handler is executed in the host thread. In the callback function, the event type is MessageEvents, indicating the received message data.
*
* @type { ?function }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
onmessage?: (event: MessageEvents) => void;
/**
* The onmessage attribute of the worker specifies the event handler
* when the worker receives a message that cannot be serialized.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The onmessage attribute of the worker specifies the event handler
* when the worker receives a message that cannot be serialized.
* The event handler is executed in the host thread.
*
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Called when the Worker thread receives a message that cannot be serialized. The event handler is executed in the host thread.
* In the callback function, the event type is MessageEvents, indicating the received message data.
*
* @type { ?function }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
onmessageerror?: (event: MessageEvents) => void;
/**
* Sends a message to the worker thread.
* The data is transferred using the structured clone algorithm.
*
* @param { Object } message - message Data to be sent to the worker
* @param { ArrayBuffer[] } transfer - transfer ArrayBuffer instance that can be transferred.
* The transferList array cannot contain null.
* @throws { BusinessError } 401 - if the input parameters are invalid.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Sends a message to the worker thread.
* The data is transferred using the structured clone algorithm.
*
* @param { Object } message - message Data to be sent to the worker
* @param { ArrayBuffer[] } transfer - transfer ArrayBuffer instance that can be transferred.
* The transferList array cannot contain null.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sends a message from the host thread to the Worker thread by transferring object ownership.
*
* @param { Object } message - Data to be sent to the Worker thread. The data object must be sequenceable.
* For details about the supported parameter types, see Sequenceable Data Types.
* @param { ArrayBuffer[] } transfer - ArrayBuffer instance holding an array of objects for which the ownership
* is transferred to the Worker thread. After the transfer, the objects are available only in the Worker thread. The array cannot be null.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
postMessage(message: Object, transfer: ArrayBuffer[]): void;
/**
* Sends a message to the worker thread.
* The data is transferred using the structured clone algorithm.
*
* @param { Object } message - message Data to be sent to the worker
* @param { PostMessageOptions } [options] - options
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Sends a message to the worker thread.
* The data is transferred using the structured clone algorithm.
*
* @param { Object } message - message Data to be sent to the worker
* @param { PostMessageOptions } [options] - options
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Sends a message from the host thread to the Worker thread by transferring object ownership or copying data.
*
* @param { Object } message - Data to be sent to the Worker thread. The data object must be sequenceable.
* For details about the supported parameter types, see Sequenceable Data Types.
* @param { PostMessageOptions } [options] - If this parameter is specified, it functions the same as ArrayBuffer[].
* Specifically, the ownership of the objects in the array is transferred to the Worker thread and becomes unavailable in the host thread.
* The objects are available only in the Worker thread. If this parameter is not specified, the default value undefined is used,
* and information is transferred to the Worker thread by copying data.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
postMessage(message: Object, options?: PostMessageOptions): void;
/**
* Sends a message from the host thread to the Worker thread. In the message, a sendable object is passed by reference,
* and a non-sendable object is passed by serialization.
*
* @param { Object } message - Data to be sent to the Worker thread. The data object must be sequenceable or sendable.
* For details about the supported sequenceable types, see Sequenceable Data Types.
* For details about the supported sendable types, see Sendable Data Types.
* @param { ArrayBuffer[] } [transfer] - ArrayBuffer instance holding an array of objects for which the ownership
* is transferred to the Worker thread. After the transfer, the objects are available only in the Worker thread.
* The array cannot be null. The default value is an empty array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
postMessageWithSharedSendable(message: Object, transfer?: ArrayBuffer[]): void;
/**
* Adds an event listener to the worker.
*
* @param { string } type - type Adds an event listener to the worker.
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Adds an event listener to the worker.
*
* @param { string } type - type Adds an event listener to the worker.
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Adds an event listener for the Worker thread. This API provides the same functionality as addEventListener9+.
*
* @param { string } type - Type of the event to listen for.
* @param { WorkerEventListener } listener - Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
on(type: string, listener: WorkerEventListener): void;
/**
* Adds an event listener to the worker
* and removes the event listener automatically after it is invoked once.
*
* @param { string } type - type Type of the event to listen for
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Adds an event listener to the worker
* and removes the event listener automatically after it is invoked once.
*
* @param { string } type - type Type of the event to listen for
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Adds an event listener for the Worker thread and removes the event listener after it is invoked once.
*
* @param { string } type - type Type of the event to listen for
* @param { WorkerEventListener } listener - listener Callback to invoke when an event of the specified type occurs
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
once(type: string, listener: WorkerEventListener): void;
/**
* Removes an event listener to the worker.
*
* @param { string } type - type Type of the event for which the event listener is removed.
* @param { WorkerEventListener } [listener] - listener Callback of the event listener to remove.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Removes an event listener to the worker.
*
* @param { string } type - type Type of the event for which the event listener is removed.
* @param { WorkerEventListener } [listener] - listener Callback of the event listener to remove.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Removes an event listener for the Worker thread. This API provides the same functionality as removeEventListener9+.
*
* @param { string } type - type Type of the event for which the event listener is removed.
* @param { WorkerEventListener } [listener] - listener Callback of the event listener to remove.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
off(type: string, listener?: WorkerEventListener): void;
/**
* Terminates the worker thread to stop the worker from receiving messages
*
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Terminates the worker thread to stop the worker from receiving messages
*
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Terminates the Worker thread to stop it from receiving messages.
*
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
terminate(): void;
/**
* Adds an event listener to the worker.
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Adds an event listener to the worker.
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @throws { BusinessError } 10200005 - The called API is not supported in the worker thread.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Adds an event listener for the Worker thread. This API provides the same functionality as on9+.
*
* @param { string } type - type Type of the event to listen for.
* @param { WorkerEventListener } listener Callback to invoke when an event of the specified type occurs.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @throws { BusinessError } 10200005 - The invoked API is not supported in workers.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
addEventListener(type: string, listener: WorkerEventListener): void;
/**
* Handle the event defined for the worker.
*
* @param { Event } event - event Event to dispatch.
* @returns { boolean }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Handle the event defined for the worker.
*
* @param { Event } event - event Event to dispatch.
* @returns { boolean }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Dispatches the event defined for the Worker thread.
*
* @param { Event } event - event Event to dispatch.
* @returns { boolean }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
dispatchEvent(event: Event): boolean;
/**
* Remove an event defined for the worker.
*
* @param { string } type - type Type of the event for which the event listener is cancelled.
* @param { WorkerEventListener } [callback] - callback Callback of the event listener to remove.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Remove an event defined for the worker.
*
* @param { string } type - type Type of the event for which the event listener is cancelled.
* @param { WorkerEventListener } [callback] - callback Callback of the event listener to remove.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Removes an event listener for the Worker thread. This API provides the same functionality as off9+.
*
* @param { string } type - type Type of the event for which the event listener is to be removed.
* @param { WorkerEventListener } [callback] - callback Callback to invoke when the listener is removed.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
removeEventListener(type: string, callback?: WorkerEventListener): void;
/**
* Remove all event listeners for the worker.
*
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Remove all event listeners for the worker.
*
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Removes all event listeners for the Worker thread.
*
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
removeAllListener(): void;
/**
* Register globalCallObject for global call.
* @param { string } instanceName - The key to register globalCallObject.
* @param { Object } globalCallObject - The globalCallObject that will be registered.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 11
*/
/**
* Registers an object with the ThreadWorker instance of the host thread.
* In this way, the methods of the object can be called in the Worker thread through callGlobalCallObjectMethod.
*
* @param { string } instanceName - Key used for registration, based on which the registered object is identified during method calling.
* @param { Object } globalCallObject - Object to register. The ThreadWorker instance holds a strong reference to the object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
registerGlobalCallObject(instanceName: string, globalCallObject: Object): void;
/**
* Remove registered globalCallObject and release strong reference to registered object.
* @param { string } [instanceName] - The exact key that used in registration.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - The Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 11
*/
/**
* Unregisters an object with the ThreadWorker instance of the host thread. This API releases the strong reference
* between the ThreadWorker instance and the target object. No error is reported if no object is matched.
*
* @param { string } [instanceName] - Key used for registration. If this parameter is left blank,
* all registered objects registered in the ThreadWorker instance are unregistered.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200004 - Worker instance is not running.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
unregisterGlobalCallObject(instanceName?: string): void;
}
/**
* The RestrictedWorker class contains all Worker functions.
*
* @extends ThreadWorker
* @syscap SystemCapability.Utils.Lang
* @since 11
*/
/**
* The RestrictedWorker class contains all Worker functions.
*
* @extends ThreadWorker
* @syscap SystemCapability.Utils.Lang
* @systemapi
* @since 12
*/
class RestrictedWorker extends ThreadWorker {
/**
* Creates a worker instance
*
* @param { string } scriptURL - scriptURL URL of the script to be executed by the worker
* @param { WorkerOptions } [options] - options Options that can be set for the worker
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failed.
* @throws { BusinessError } 10200007 - The worker file path is invalid.
* @syscap SystemCapability.Utils.Lang
* @since 11
*/
/**
* Creates a worker instance
*
* @param { string } scriptURL - scriptURL URL of the script to be executed by the worker
* @param { WorkerOptions } [options] - options Options that can be set for the worker
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @throws { BusinessError } 10200003 - Worker initialization failure.
* @throws { BusinessError } 10200007 - The worker file patch is invalid path.
* @syscap SystemCapability.Utils.Lang
* @systemapi
* @since 12
*/
constructor(scriptURL: string, options?: WorkerOptions);
}
/**
* The Worker class contains all Worker functions.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker
*/
class Worker implements EventTarget {
/**
* Creates a worker instance
*
* @param { string } scriptURL - scriptURL URL of the script to be executed by the worker
* @param { WorkerOptions } options - options Options that can be set for the worker
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker.constructor
*/
constructor(scriptURL: string, options?: WorkerOptions);
/**
* The onexit attribute of the worker specifies the event handler to be called
* when the worker exits. The handler is executed in the host thread.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker.onexit
*/
onexit?: (code: number) => void;
/**
* The onerror attribute of the worker specifies the event handler to be called
* when an exception occurs during worker execution.
* The event handler is executed in the host thread.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker.onerror
*/
onerror?: (err: ErrorEvent) => void;
/**
* The onmessage attribute of the worker specifies the event handler
* to be called then the host thread receives a message created by itself
* and sent by the worker through the parentPort.postMessage.
* The event handler is executed in the host thread.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker.onmessage
*/
onmessage?: (event: MessageEvent) => void;
/**
* The onmessage attribute of the worker specifies the event handler
* when the worker receives a message that cannot be serialized.
* The event handler is executed in the host thread.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker.onmessageerror
*/
onmessageerror?: (event: MessageEvent) => void;
/**
* Sends a message to the worker thread.
* The data is transferred using the structured clone algorithm.
*
* @param { Object } message - message - message Data to be sent to the worker
* @param { ArrayBuffer[] } transfer - transfer ArrayBuffer instance that can be transferred.
* The transferList array cannot contain null.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker.postMessage
*/
postMessage(message: Object, transfer: ArrayBuffer[]): void;
/**
* Sends a message to the worker thread.
* The data is transferred using the structured clone algorithm.
*
* @param { Object } message - message - message Data to be sent to the worker
* @param { PostMessageOptions } [options] - options Option can be set for postmessage.
* The transferList array cannot contain null.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker.postMessage
*/
postMessage(message: Object, options?: PostMessageOptions): void;
/**
* Adds an event listener to the worker.
*
* @param { string } type - type Adds an event listener to the worker.
* @param { EventListener } listener - listener Callback to invoke when an event of the specified type occurs.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker.on
*/
on(type: string, listener: EventListener): void;
/**
* Adds an event listener to the worker
* and removes the event listener automatically after it is invoked once.
*
* @param { string } type - type Type of the event to listen for
* @param { EventListener } listener - listener Callback to invoke when an event of the specified type occurs
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker.once
*/
once(type: string, listener: EventListener): void;
/**
* Removes an event listener to the worker.
*
* @param { string } type - type Type of the event for which the event listener is removed.
* @param { EventListener } listener - listener Callback of the event listener to remove.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker.off
*/
off(type: string, listener?: EventListener): void;
/**
* Terminates the worker thread to stop the worker from receiving messages
*
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.ThreadWorker.terminate
*/
terminate(): void;
}
/**
* The object used by the worker thread to communicate with the host thread.
*
* @constant
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.worker.workerPort
*/
const parentPort: DedicatedWorkerGlobalScope;
/**
* The object used by the worker thread to communicate with the host thread.
*
* @constant
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The object used by the worker thread to communicate with the host thread.
*
* @constant
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The object used by the worker thread to communicate with the host thread.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
const workerPort: ThreadWorkerGlobalScope;
}
export default worker;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助