@dfinity/utils 2.13.1-next-2025-07-01 → 2.13.1-next-2025-07-07

package/README.md

@@ -85,6 +85,10 @@ Parameters:
 
 - `amount`: - in string format
 
+Returns:
+
+bigint | FromStringToTokenError
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/parser/token.ts#L12)
 
 #### :gear: isNullish
@@ -99,6 +103,10 @@ Parameters:
 
 - `argument`: - The argument to check.
 
+Returns:
+
+`true` if the argument is null or undefined; otherwise, `false`.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/nullish.utils.ts#L8)
 
 #### :gear: nonNullish
@@ -113,6 +121,10 @@ Parameters:
 
 - `argument`: - The argument to check.
 
+Returns:
+
+`true` if the argument is not null or undefined; otherwise, `false`.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/nullish.utils.ts#L19)
 
 #### :gear: notEmptyString
@@ -127,6 +139,10 @@ Parameters:
 
 - `value`: - The value to check.
 
+Returns:
+
+`true` if the value is not null, not undefined, and not an empty string; otherwise, `false`.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/nullish.utils.ts#L29)
 
 #### :gear: isEmptyString
@@ -141,6 +157,10 @@ Parameters:
 
 - `value`: - The value to check.
 
+Returns:
+
+Type predicate indicating if the value is null, undefined, or an empty string.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/nullish.utils.ts#L39)
 
 #### :gear: queryAndUpdate
@@ -179,6 +199,10 @@ Parameters:
 - `params.identity`: The identity to use for the request.
 - `params.resolution`: The resolution to use. Default is `race`.
 
+Returns:
+
+A promise that resolves when the request is done.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/services/query.ts#L36)
 
 #### :gear: defaultAgent
@@ -189,6 +213,10 @@ Get a default agent that connects to mainnet with the anonymous identity.
 | -------------- | ------------- |
 | `defaultAgent` | `() => Agent` |
 
+Returns:
+
+The default agent to use
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/agent.utils.ts#L14)
 
 #### :gear: createAgent
@@ -334,6 +362,10 @@ Parameters:
 
 - `input`: The input array to encode.
 
+Returns:
+
+A Base32 string encoding the input.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/base32.utils.ts#L21)
 
 #### :gear: decodeBase32
@@ -363,6 +395,10 @@ Parameters:
 
 - `uint8Array`: - The Uint8Array containing binary data to be encoded.
 
+Returns:
+
+- The base64 encoded string representation of the binary data.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/base64.utils.ts#L7)
 
 #### :gear: base64ToUint8Array
@@ -377,6 +413,10 @@ Parameters:
 
 - `base64String`: - The base64 encoded string to be decoded.
 
+Returns:
+
+- The Uint8Array representation of the decoded binary data.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/base64.utils.ts#L16)
 
 #### :gear: bigEndianCrc32
@@ -407,6 +447,10 @@ Parameters:
 - `_key`: - Ignored. Only provided for API compatibility.
 - `value`: - The value to transform before stringification.
 
+Returns:
+
+The transformed value if it matches a known type, otherwise the original value.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/json.utils.ts#L22)
 
 #### :gear: jsonReviver
@@ -430,6 +474,10 @@ Parameters:
 - `_key`: - Ignored but provided for API compatibility.
 - `value`: - The parsed value to transform.
 
+Returns:
+
+The reconstructed value if it matches a known type, otherwise the original value.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/json.utils.ts#L53)
 
 #### :gear: hashObject
@@ -447,6 +495,10 @@ Parameters:
 
 - `params`: - The object to hash.
 
+Returns:
+
+A promise that resolves to the hex string of the SHA-256 hash.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/crypto.utils.ts#L14)
 
 #### :gear: hashText
@@ -464,6 +516,10 @@ Parameters:
 
 - `text`: - The text to hash.
 
+Returns:
+
+A promise that resolves to the hex string of the SHA-256 hash.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/crypto.utils.ts#L31)
 
 #### :gear: secondsToDuration
@@ -480,6 +536,10 @@ Parameters:
 - `options.seconds`: - The number of seconds to convert.
 - `options.i18n`: - The i18n object for customizing language and units. Defaults to English.
 
+Returns:
+
+The human-readable duration string.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/date.utils.ts#L43)
 
 #### :gear: nowInBigIntNanoSeconds
@@ -490,6 +550,10 @@ Returns the current timestamp in nanoseconds as a `bigint`.
 | ------------------------ | -------------- |
 | `nowInBigIntNanoSeconds` | `() => bigint` |
 
+Returns:
+
+The current timestamp in nanoseconds.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/date.utils.ts#L123)
 
 #### :gear: toBigIntNanoSeconds
@@ -504,6 +568,10 @@ Parameters:
 
 - `date`: - The `Date` object to convert.
 
+Returns:
+
+The timestamp in nanoseconds.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/date.utils.ts#L132)
 
 #### :gear: debounce
@@ -523,6 +591,10 @@ Parameters:
 - `func`: - The function to debounce. It will only be called after no new calls happen within the specified timeout.
 - `timeout`: - The debounce delay in milliseconds. Defaults to 300ms if not provided or invalid.
 
+Returns:
+
+A debounced version of the original function.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/debounce.utils.ts#L13)
 
 #### :gear: toNullable
@@ -537,6 +609,10 @@ Parameters:
 
 - `value`: - The value to convert into a Candid-style variant.
 
+Returns:
+
+A Candid-style variant representation: an empty array for `null` and `undefined` or an array with the value.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/did.utils.ts#L12)
 
 #### :gear: fromNullable
@@ -551,6 +627,10 @@ Parameters:
 
 - `value`: - A Candid-style variant representing an optional value.
 
+Returns:
+
+The extracted value, or `undefined` if the array is empty.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/did.utils.ts#L22)
 
 #### :gear: fromDefinedNullable
@@ -566,6 +646,10 @@ Parameters:
 
 - `value`: - A Candid-style variant representing an optional value.
 
+Returns:
+
+The extracted value.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/did.utils.ts#L34)
 
 #### :gear: fromNullishNullable
@@ -580,6 +664,10 @@ Parameters:
 
 - `value`: - A Candid-style variant or `undefined`.
 
+Returns:
+
+The extracted value, or `undefined` if the input is nullish or the array is empty.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/did.utils.ts#L49)
 
 #### :gear: principalToSubAccount
@@ -611,6 +699,10 @@ Parameters:
 - `params.minVersion`: Ex: "1.0.0"
 - `params.currentVersion`: Ex: "2.0.0"
 
+Returns:
+
+boolean
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/version.utils.ts#L34)
 
 ### :wrench: Constants
@@ -709,6 +801,10 @@ Parameters:
 | ------- | -------------- |
 | `toE8s` | `() => bigint` |
 
+Returns:
+
+The amount of e8s.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/parser/token.ts#L224)
 
 ### :factory: TokenAmountV2
@@ -785,6 +881,10 @@ Parameters:
 | -------- | -------------- |
 | `toUlps` | `() => bigint` |
 
+Returns:
+
+The amount of ulps.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/parser/token.ts#L324)
 
 ##### :gear: toE8s
@@ -793,6 +893,10 @@ Parameters:
 | ------- | -------------- |
 | `toE8s` | `() => bigint` |
 
+Returns:
+
+The amount of ulps in e8s precision
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/parser/token.ts#L332)
 
 ### :factory: Canister
@@ -829,6 +933,10 @@ Parameters:
 - `config.fetchRootKey`: - Whether to fetch the root key for certificate validation.
 - `config.host`: - The host to connect to.
 
+Returns:
+
+A new instance of `AgentManager`.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/agent.utils.ts#L72)
 
 #### Methods
@@ -851,6 +959,10 @@ Parameters:
 
 - `identity`: - The identity to be used to create the agent.
 
+Returns:
+
+The HttpAgent associated with the given identity.
+
 [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/agent.utils.ts#L85)
 
 ##### :gear: clearAgents

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dfinity/utils",
-  "version": "2.13.1-next-2025-07-01",
+  "version": "2.13.1-next-2025-07-07",
   "description": "A collection of utilities and constants for NNS/SNS projects.",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.cjs.js",