openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-11-27 01:11:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

!11980 support taskpool generics

Browse Source 
Merge pull request !11980 from wangzhaoyong/generics0608
This commit is contained in:
openharmony_ci 2024-08-26 02:10:14 +00:00 committed by Gitee
commit e5e3cb803e
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
1 changed files with 101 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
api/@ohos.taskpool.d.ts vendored
View File

@ -774,6 +774,43 @@ declare namespace taskpool {
class LongTask extends Task {
}
/**
* The GenericsTask class provides an interface to create a task with generics.
*
* @extends Task
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
class GenericsTask<A extends Array<Object>, R> extends Task {
/**
* Create a GenericsTask instance.
*
* @param { (...args: A) => R | Promise<R> } func - Concurrent function to execute in taskpool.
* @param { A } args - The concurrent function arguments.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
constructor(func: (...args: A) => R | Promise<R>, ...args: A);
/**
* Create a GenericsTask instance.
*
* @param { string } name - The name of GenericsTask.
* @param { (...args: A) => R | Promise<R> } func - Concurrent function to execute in taskpool.
* @param { A } args - The concurrent function arguments.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
constructor(name: string, func: (...args: A) => R | Promise<R>, ...args: A);
}
/**
* The State defines the task state.
*
@ -1134,6 +1171,21 @@ declare namespace taskpool {
*/
function execute(func: Function, ...args: Object[]): Promise<Object>;
/**
* Execute a concurrent function with generics.
*
* @param { (...args: A) => R | Promise<R> } func - Concurrent function want to execute.
* @param { A } args - The concurrent function arguments.
* @returns { Promise<R> }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
function execute<A extends Array<Object>, R>(func: (...args: A) => R | Promise<R>, ...args: A): Promise<R>;
/**
* Execute a concurrent task.
*
@ -1205,6 +1257,22 @@ declare namespace taskpool {
*/
function execute(task: Task, priority?: Priority): Promise<Object>;
/**
* Execute a concurrent task with generics.
*
* @param { GenericsTask<A, R> } task - The task want to execute.
* @param { Priority } [priority] - Task priority, MEDIUM is default.
* @returns { Promise<R> }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
function execute<A extends Array<Object>, R>(task: GenericsTask<A, R>, priority?: Priority): Promise<R>;
/**
* Execute a concurrent task group.
*
@ -1277,6 +1345,22 @@ declare namespace taskpool {
*/
function executeDelayed(delayTime: number, task: Task, priority?: Priority): Promise<Object>;
/**
* Execute a concurrent task with generics after the specified time.
*
* @param { number } delayTime - The time want to delay.
* @param { GenericsTask<A, R> } task - The task want to execute.
* @param { Priority } [priority] - Task priority, MEDIUM is default.
* @returns { Promise<R> }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200028 - The delayTime is less than zero.
* @throws { BusinessError } 10200051 - The periodic task cannot be executed again.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
function executeDelayed<A extends Array<Object>, R>(delayTime: number, task: GenericsTask<A, R>, priority?: Priority): Promise<R>;
/**
* Execute a concurrent task periodically.
*
@ -1298,6 +1382,23 @@ declare namespace taskpool {
*/
function executePeriodically(period: number, task: Task, priority?: Priority): void;
/**
* Execute a concurrent task with generics periodically.
*
* @param { number } period - The period in milliseconds for executing task.
* @param { GenericsTask<A, R> } task - The task want to execute.
* @param { Priority } [priority] - Task priority, MEDIUM is default.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
* @throws { BusinessError } 10200006 - An exception occurred during serialization.
* @throws { BusinessError } 10200014 - The function is not marked as concurrent.
* @throws { BusinessError } 10200028 - The period is less than zero.
* @throws { BusinessError } 10200050 - The concurrent task has been executed and cannot be executed periodically.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 13
*/
function executePeriodically<A extends Array<Object>, R>(period: number, task: GenericsTask<A, R>, priority?: Priority): void;
/**
* Cancel a concurrent task.
*