From 9dda67de60c1cc717bb76cdaa26778ffffc2d7df Mon Sep 17 00:00:00 2001 From: Marcin Gordel Date: Wed, 19 Jun 2024 14:35:37 +0200 Subject: [PATCH] docs: added typedoc comments for oneOf and manyOf --- src/golem-network/golem-network.ts | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/golem-network/golem-network.ts b/src/golem-network/golem-network.ts index 85c7e2b1d..686747594 100644 --- a/src/golem-network/golem-network.ts +++ b/src/golem-network/golem-network.ts @@ -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 { const proposalPool = new DraftOfferProposalPool({ @@ -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 { const proposalPool = new DraftOfferProposalPool({