repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Take change from jerome
[poolifier.git]
/
src
/
pools
/
pool.ts
diff --git
a/src/pools/pool.ts
b/src/pools/pool.ts
index e8f391cc4dc3c6f399194d82d93e92ec00c22dfc..f96e5c0cbff3ed84afe5d06c6ac8f2097539ba9f 100644
(file)
--- a/
src/pools/pool.ts
+++ b/
src/pools/pool.ts
@@
-1,4
+1,19
@@
+/**
+ * Contract definition for a poolifier pool.
+ *
+ * @template Data Type of data sent to the worker.
+ * @template Response Type of response of execution.
+ */
export interface IPool<Data = unknown, Response = unknown> {
export interface IPool<Data = unknown, Response = unknown> {
- destroy(): Promise<void>
+ /**
+ * Perform the task specified in the constructor with the data parameter.
+ *
+ * @param data The input for the specified task.
+ * @returns Promise that will be resolved when the task is successfully completed.
+ */
execute(data: Data): Promise<Response>
execute(data: Data): Promise<Response>
+ /**
+ * Shut down every current worker in this pool.
+ */
+ destroy(): Promise<void>
}
}