Skip to content

Commit

Permalink
mark contract/utils functions as private in JSDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
ElliotFriend committed May 17, 2024
1 parent a0e21ff commit b684b80
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/contract/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export const DEFAULT_TIMEOUT = 5 * 60;
/**
* Keep calling a `fn` for `timeoutInSeconds` seconds, if `keepWaitingIf` is
* true. Returns an array of all attempts to call the function.
* @private
*/
export async function withExponentialBackoff<T>(
/** Function to call repeatedly */
Expand Down Expand Up @@ -92,6 +93,7 @@ export const contractErrorPattern = /Error\(Contract, #(\d+)\)/;

/**
* A TypeScript type guard that checks if an object has a `toString` method.
* @private
*/
export function implementsToString(
/** some object that may or may not have a `toString` method */
Expand All @@ -102,6 +104,7 @@ export function implementsToString(

/**
* Reads a binary stream of ScSpecEntries into an array for processing by ContractSpec
* @private
*/
export function processSpecEntryStream(buffer: Buffer) {
const reader = new cereal.XdrReader(buffer);
Expand Down

0 comments on commit b684b80

Please sign in to comment.