Skip to content

Commit

Permalink
docs: added typedoc comments for oneOf and manyOf
Browse files Browse the repository at this point in the history
  • Loading branch information
mgordel committed Jun 19, 2024
1 parent 1cd8f00 commit 9dda67d
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions src/golem-network/golem-network.ts
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,11 @@ export class GolemNetwork {
* await lease.finalize();
* ```
*
* @param options timeout in milliseconds or an AbortSignal that will be used to cancel the lease request
* @param {Object} options
* @param options.order - represents the order specifications which will result in access to LeaseProcess.
* @param options.signalOrTimeout - timeout in milliseconds or an AbortSignal that will be used to cancel the lease request
* @param options.setup - an optional function that is called as soon as the exe unit is ready
* @param options.teardown - an optional function that is called before the exe unit is destroyed
*/
async oneOf({ order, setup, teardown, signalOrTimeout }: OneOfOptions): Promise<LeaseProcess> {
const proposalPool = new DraftOfferProposalPool({
Expand Down Expand Up @@ -462,7 +466,11 @@ export class GolemNetwork {
* ]);
* ```
*
* @param options Demand specification and concurrency level
* @param @param {Object} options
* @param options.order - represents the order specifications which will result in access to LeaseProcess.
* @param options.concurrency - concurrency level, can be defined as a number or an object with min and max fields
* @param options.setup - an optional function that is called as soon as the exe unit is ready
* @param options.teardown - an optional function that is called before the exe unit is destroyed
*/
public async manyOf({ concurrency, order, setup, teardown }: ManyOfOptions): Promise<LeaseProcessPool> {
const proposalPool = new DraftOfferProposalPool({
Expand Down

0 comments on commit 9dda67d

Please sign in to comment.