@dfinity/utils 0.0.18-next-2023-07-03 → 0.0.18

package/README.md

@@ -71,6 +71,8 @@ Parameters:
 
 - `amount`: - in string format
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/parser/token.ts#L10)
+
 #### :gear: defaultAgent
 
 Get a default agent that connects to mainnet with the anonymous identity.
@@ -79,6 +81,8 @@ Get a default agent that connects to mainnet with the anonymous identity.
 | -------------- | ------------- |
 | `defaultAgent` | `() => Agent` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/agent.utils.ts#L8)
+
 #### :gear: createAgent
 
 Create an agent for a given identity
@@ -93,78 +97,104 @@ Parameters:
 - `host`: An optional host to connect to
 - `fetchRootKey`: Fetch root key for certificate validation during local development or on testnet
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/agent.utils.ts#L20)
+
 #### :gear: createServices
 
 | Function         | Type                                                                                                                                                                                                                                                            |
 | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `createServices` | `<T>({ options: { canisterId, serviceOverride, certifiedServiceOverride, agent: agentOption, }, idlFactory, certifiedIdlFactory, }: { options: RequiredCanisterOptions<T>; idlFactory: InterfaceFactory; certifiedIdlFactory: InterfaceFactory; }) => { ...; }` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/actor.utils.ts#L13)
+
 #### :gear: assertNonNullish
 
 | Function           | Type                                                                 |
 | ------------------ | -------------------------------------------------------------------- |
 | `assertNonNullish` | `<T>(value: T, message?: string) => asserts value is NonNullable<T>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/asserts.utils.ts#L7)
+
 #### :gear: assertPercentageNumber
 
 | Function                 | Type                           |
 | ------------------------ | ------------------------------ |
 | `assertPercentageNumber` | `(percentage: number) => void` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/asserts.utils.ts#L15)
+
 #### :gear: uint8ArrayToBigInt
 
 | Function             | Type                            |
 | -------------------- | ------------------------------- |
 | `uint8ArrayToBigInt` | `(array: Uint8Array) => bigint` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/arrays.utils.ts#L3)
+
 #### :gear: bigIntToUint8Array
 
 | Function             | Type                            |
 | -------------------- | ------------------------------- |
 | `bigIntToUint8Array` | `(value: bigint) => Uint8Array` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/arrays.utils.ts#L15)
+
 #### :gear: numberToUint8Array
 
 | Function             | Type                            |
 | -------------------- | ------------------------------- |
 | `numberToUint8Array` | `(value: number) => Uint8Array` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/arrays.utils.ts#L31)
+
 #### :gear: arrayBufferToUint8Array
 
 | Function                  | Type                                  |
 | ------------------------- | ------------------------------------- |
 | `arrayBufferToUint8Array` | `(buffer: ArrayBuffer) => Uint8Array` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/arrays.utils.ts#L40)
+
 #### :gear: uint8ArrayToArrayOfNumber
 
 | Function                    | Type                              |
 | --------------------------- | --------------------------------- |
 | `uint8ArrayToArrayOfNumber` | `(array: Uint8Array) => number[]` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/arrays.utils.ts#L43)
+
 #### :gear: arrayOfNumberToUint8Array
 
 | Function                    | Type                                |
 | --------------------------- | ----------------------------------- |
 | `arrayOfNumberToUint8Array` | `(numbers: number[]) => Uint8Array` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/arrays.utils.ts#L46)
+
 #### :gear: asciiStringToByteArray
 
 | Function                 | Type                         |
 | ------------------------ | ---------------------------- |
 | `asciiStringToByteArray` | `(text: string) => number[]` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/arrays.utils.ts#L49)
+
 #### :gear: hexStringToUint8Array
 
 | Function                | Type                                |
 | ----------------------- | ----------------------------------- |
 | `hexStringToUint8Array` | `(hexString: string) => Uint8Array` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/arrays.utils.ts#L52)
+
 #### :gear: uint8ArrayToHexString
 
 | Function                | Type                            |
 | ----------------------- | ------------------------------- |
 | `uint8ArrayToHexString` | `(bytes: Uint8Array) => string` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/arrays.utils.ts#L60)
+
 #### :gear: encodeBase32
 
 Encode an Uint8Array to a base32 string.
@@ -177,6 +207,8 @@ Parameters:
 
 - `input`: The input array to encode.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/base32.utils.ts#L21)
+
 #### :gear: decodeBase32
 
 Decode a base32 string to Uint8Array.
@@ -190,18 +222,24 @@ Parameters:
 - `input`: The input string to decode.
 - `input`: The base32 encoded string to decode.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/base32.utils.ts#L67)
+
 #### :gear: bigEndianCrc32
 
 | Function         | Type                                |
 | ---------------- | ----------------------------------- |
 | `bigEndianCrc32` | `(bytes: Uint8Array) => Uint8Array` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/crc.utils.ts#L61)
+
 #### :gear: debounce
 
 | Function   | Type                                                                 |
 | ---------- | -------------------------------------------------------------------- |
 | `debounce` | `(func: Function, timeout?: number) => (...args: unknown[]) => void` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/debounce.utils.ts#L2)
+
 #### :gear: isNullish
 
 Is null or undefined
@@ -210,6 +248,8 @@ Is null or undefined
 | ----------- | -------------------------------------- |
 | `isNullish` | `<T>(argument: T) => argument is null` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/nullish.utils.ts#L2)
+
 #### :gear: nonNullish
 
 Not null and not undefined
@@ -218,6 +258,8 @@ Not null and not undefined
 | ------------ | ------------------------------------------------ |
 | `nonNullish` | `<T>(argument: T) => argument is NonNullable<T>` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/nullish.utils.ts#L7)
+
 #### :gear: notEmptyString
 
 Not null and not undefined and not empty
@@ -226,24 +268,32 @@ Not null and not undefined and not empty
 | ---------------- | ---------------------------- |
 | `notEmptyString` | `(value: string) => boolean` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/nullish.utils.ts#L12)
+
 #### :gear: toNullable
 
 | Function     | Type                          |
 | ------------ | ----------------------------- |
 | `toNullable` | `<T>(value?: T) => [] or [T]` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/did.utils.ts#L4)
+
 #### :gear: fromNullable
 
 | Function       | Type                         |
 | -------------- | ---------------------------- |
 | `fromNullable` | `<T>(value: [] or [T]) => T` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/did.utils.ts#L8)
+
 #### :gear: fromDefinedNullable
 
 | Function              | Type                         |
 | --------------------- | ---------------------------- |
 | `fromDefinedNullable` | `<T>(value: [] or [T]) => T` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/did.utils.ts#L12)
+
 #### :gear: principalToSubAccount
 
 Convert a principal to a Uint8Array 32 length.
@@ -257,6 +307,8 @@ Parameters:
 
 - `principal`: The principal that needs to be converted to Subaccount
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/principal.utils.ts#L8)
+
 #### :gear: smallerVersion
 
 Returns true if the current version is smaller than the minVersion, false if equal or bigger.
@@ -266,6 +318,8 @@ Tags after patch version are ignored, e.g. 1.0.0-beta.1 is considered equal to 1
 | ---------------- | ----------------------------------------------------------------------------------------------- |
 | `smallerVersion` | `({ minVersion, currentVersion, }: { minVersion: string; currentVersion: string; }) => boolean` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/version.utils.ts#L28)
+
 ### :wrench: Constants
 
 - [E8S_PER_TOKEN](#gear-e8s_per_token)
@@ -277,16 +331,22 @@ Tags after patch version are ignored, e.g. 1.0.0-beta.1 is considered equal to 1
 | --------------- | -------- |
 | `E8S_PER_TOKEN` | `bigint` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/constants/constants.ts#L1)
+
 #### :gear: ICPToken
 
 | Constant   | Type    |
 | ---------- | ------- |
 | `ICPToken` | `Token` |
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/parser/token.ts#L62)
+
 ### :factory: TokenAmount
 
 Represents an amount of tokens.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/parser/token.ts#L73)
+
 #### Methods
 
 - [fromE8s](#gear-frome8s)
@@ -307,6 +367,8 @@ Parameters:
 - `params.amount`: The amount in bigint format.
 - `params.token`: The token type.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/parser/token.ts#L83)
+
 ##### :gear: fromString
 
 Initialize from a string. Accepted formats:
@@ -324,6 +386,8 @@ Parameters:
 - `params.amount`: The amount in string format.
 - `params.token`: The token type.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/parser/token.ts#L104)
+
 ##### :gear: fromNumber
 
 Initialize from a number.
@@ -339,42 +403,26 @@ Parameters:
 - `params.amount`: The amount in number format.
 - `params.token`: The token type.
 
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/parser/token.ts#L128)
+
 ##### :gear: toE8s
 
 | Method  | Type           |
 | ------- | -------------- |
 | `toE8s` | `() => bigint` |
 
-### :factory: Canister
-
-#### Constructors
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/parser/token.ts#L154)
 
-`public`
-
-Parameters:
+### :factory: Canister
 
-- `id`
-- `service`
-- `certifiedService`
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/services/canister.ts#L4)
 
 ### :factory: InvalidPercentageError
 
-#### Constructors
-
-`public`
-
-Parameters:
-
-- `message`
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/asserts.utils.ts#L1)
 
 ### :factory: NullishError
 
-#### Constructors
-
-`public`
-
-Parameters:
-
-- `message`
+[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/utils/src/utils/asserts.utils.ts#L2)
 
 <!-- TSDOC_END -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dfinity/utils",
-  "version": "0.0.18-next-2023-07-03",
+  "version": "0.0.18",
   "description": "A collection of utilities and constants for NNS/SNS projects.",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.cjs.js",
@@ -47,8 +47,8 @@
     "service-nervous-system"
   ],
   "peerDependencies": {
-    "@dfinity/agent": "*",
-    "@dfinity/candid": "*",
-    "@dfinity/principal": "*"
+    "@dfinity/agent": "^0.15.4",
+    "@dfinity/candid": "^0.15.4",
+    "@dfinity/principal": "^0.15.4"
   }
-}
+}