Skip to content

Commit c3971ab

Browse files
committed
docs: updated jsdocs for flatworm generation
1 parent d6be75f commit c3971ab

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

src.ts/providers/plugins-network.ts

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,9 +231,20 @@ export class FetchUrlFeeDataNetworkPlugin extends NetworkPlugin {
231231
readonly #url: string;
232232
readonly #processFunc: (f: () => Promise<FeeData>, p: Provider, r: FetchRequest) => Promise<{ gasPrice?: null | bigint, maxFeePerGas?: null | bigint, maxPriorityFeePerGas?: null | bigint }>;
233233

234-
get url() { return this.#url; }
235-
get processFunc() { return this.#processFunc; }
234+
/**
235+
* The URL to initialize the FetchRequest with in %%processFunc%%.
236+
*/
237+
get url(): string { return this.#url; }
236238

239+
/**
240+
* The callback to use when computing the FeeData.
241+
*/
242+
get processFunc(): (f: () => Promise<FeeData>, p: Provider, r: FetchRequest) => Promise<{ gasPrice?: null | bigint, maxFeePerGas?: null | bigint, maxPriorityFeePerGas?: null | bigint }> { return this.#processFunc; }
243+
244+
/**
245+
* Creates a new **FetchUrlFeeDataNetworkPlugin** which will
246+
* be used when computing the fee data for the network.
247+
*/
237248
constructor(url: string, processFunc: (f: () => Promise<FeeData>, p: Provider, r: FetchRequest) => Promise<{ gasPrice?: null | bigint, maxFeePerGas?: null | bigint, maxPriorityFeePerGas?: null | bigint }>) {
238249
super("org.ethers.plugins.network.FetchUrlFeeDataPlugin");
239250
this.#url = url;

0 commit comments

Comments
 (0)