fix: added docs for isReadOnly function (FuelLabs#2564)

* chore: added doc block for `isReadOnly` functions * chore: changeset --------- Co-authored-by: Anderson Arboleya <[email protected]>
petertonysmith94 · Jun 21, 2024 · 0206568 · 0206568
1 parent 95d351b
commit 0206568
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/.changeset/strong-ducks-tie.md b/.changeset/strong-ducks-tie.md
@@ -0,0 +1,5 @@
+---
+"@fuel-ts/program": patch
+---
+
+fix: added docs for `isReadOnly` function
diff --git a/packages/program/src/types.ts b/packages/program/src/types.ts
@@ -62,6 +62,11 @@ export type CallConfig<T = unknown> = {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export interface InvokeFunction<TArgs extends Array<any> = Array<any>, TReturn = any> {
   (...args: TArgs): FunctionInvocationScope<TArgs, TReturn>;
+  /**
+   * Checks if the function is read-only i.e. it only reads from storage, does not write to it.
+   *
+   * @returns True if the function is read-only or pure, false otherwise.
+   */
   isReadOnly: () => boolean;
 }