mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 06:03:30 +00:00
85ff14c0ef
Issue: https://gitee.com/openharmony/interface_sdk-js/issues/IAHNNR Signed-off-by: milkpotatoes <chenshulin5@huawei.com> Change-Id: Idb07b30b5aecbe622cee6185f1f20aa415d68e78
2346 lines
83 KiB
TypeScript
2346 lines
83 KiB
TypeScript
/*
|
|
* 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 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 executes the script.
|
|
*
|
|
* @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.
|
|
*
|
|
* @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 the worker is shared.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
shared?: boolean;
|
|
}
|
|
|
|
/**
|
|
* @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.
|
|
*
|
|
* @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 occurred during worker execution.
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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
|
|
*/
|
|
/**
|
|
* 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
|
|
*/
|
|
/**
|
|
* Saves the data transferred between worker thread and host thread.
|
|
* @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
|
|
* Specifies the object whose ownership need to be transferred during data transfer.
|
|
* The object must be ArrayBuffer.
|
|
* @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.
|
|
*
|
|
* @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 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
|
|
* Specific worker event features.
|
|
* @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 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
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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
|
|
* @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
|
|
*/
|
|
/**
|
|
* Remove all event listeners for the worker.
|
|
*
|
|
* @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
|
|
*/
|
|
/**
|
|
* The environment Specified in which worker threads run, which is isolated from the host thread environment.
|
|
* @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
|
|
*/
|
|
/**
|
|
* Name of Worker specified when there is a new worker.
|
|
*
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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.
|
|
*
|
|
* @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
|
|
*/
|
|
/**
|
|
* Specify the type attribute for self.
|
|
*
|
|
* @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
|
|
*/
|
|
/**
|
|
* Specifies the thread-worker running environment, which is isolated from the host-thread environment
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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.
|
|
*
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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.
|
|
*
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
postMessage(messageObject: Object, options?: PostMessageOptions): void;
|
|
|
|
/**
|
|
* Send a message to the host thread from the worker thread.
|
|
* If there're sendable objects included in the message, they will be passed through references.
|
|
* Non-sendable objects are passed through serialization.
|
|
*
|
|
* @param { Object } message - Data to be sent to the worker thread.
|
|
* @param { ArrayBuffer[] } [transfer] - ArrayBuffer instance that can be transferred.
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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 - 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;
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
/**
|
|
* The ThreadWorker class contains all Worker functions.
|
|
*
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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.
|
|
*
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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.
|
|
*
|
|
* @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;
|
|
/**
|
|
* 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
|
|
*/
|
|
/**
|
|
* 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.
|
|
*
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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.
|
|
*
|
|
* @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 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
|
|
* @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 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
|
|
* @atomicservice
|
|
* @since 11
|
|
*/
|
|
postMessage(message: Object, options?: PostMessageOptions): void;
|
|
|
|
/**
|
|
* Sends a message to the worker thread from the host thread.
|
|
* If there're sendable objects included in the message, they will be passed through references.
|
|
* Non-sendable objects are passed through serialization.
|
|
*
|
|
* @param { Object } message - Data to be sent to the worker thread.
|
|
* @param { ArrayBuffer[] } [transfer] - ArrayBuffer instance that can be transferred.
|
|
* @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 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 - 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 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 - 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 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 - 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 the worker 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 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 - 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
|
|
*/
|
|
/**
|
|
* 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 - 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
|
|
*/
|
|
/**
|
|
* 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 - 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
|
|
*/
|
|
/**
|
|
* Remove all event listeners for the worker.
|
|
*
|
|
* @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
|
|
*/
|
|
/**
|
|
* 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 - 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
|
|
*/
|
|
/**
|
|
* 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 - 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
|
|
* @atomicservice
|
|
* @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
|
|
* @atomicservice
|
|
* @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;
|