Comments and minor improvements for utils.ts #83
+140
−54
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
September 6, 2023 10:58
Refactored the checkResponseError function to handle Axios errors more effectively. Now, if an error response contains either an "error" or a "detail" property, it will throw an Error with the corresponding message. This change improves the error reporting and makes the code more robust. Closes cashubtc#123
The `isObj` function in the `utils.ts` file has been updated to provide more accurate type checking. Instead of simply checking if the value is an object, it now checks if the value is an object with a string key and unknown value. This change improves the reliability of type checking in the codebase, because in TypeScript, null is considered an object, which can lead to unexpected behavior.
- added explainer comments - made check response error more concise
callebtc
approved these changes
Sep 12, 2023
gandlafbtc
requested changes
Sep 19, 2023
added 2 commits
October 9, 2023 08:33
changes: - Exported `splitAmount`, `getDefaultAmountPreference`, `bytesToNumber`, `hexToNumber`, and `bigIntStringify` functions. - Added JSDoc comments for new functions: `isPowerOfTwo`, `getPreference`, and other utility functions. - Improved code readability by adding line breaks and indentation.
gandlafbtc
reviewed
Dec 8, 2023
src/utils.ts
Outdated
| * Checks if a number is a power of two. | ||
| * @param number The number to check | ||
| * @returns True if the number is a power of two, false otherwise | ||
| */ | ||
| function isPowerOfTwo(number: number) { |
There was a problem hiding this comment.
while we're at it, can you add the return type to this function signature?
src/utils.ts
Outdated
| * @returns | ||
| * Derives the keyset id from a set of keys. | ||
| * @param keys The keys to derive the keyset id from | ||
| * @returns The derived keyset id | ||
| */ | ||
| export function deriveKeysetId(keys: MintKeys) { |
There was a problem hiding this comment.
Can you add the missing return type here?
src/utils.ts
Outdated
| * Sorts an array of proofs by id. | ||
| * @param proofs The proofs to sort | ||
| * @returns The sorted proofs | ||
| */ | ||
| export function sortProofsById(proofs: Array<Proof>) { |
Added try-catch block to handle errors when getting preferences. Log error message if an exception occurs during preference retrieval.
- Refactored code to separate prefix removal logic into a new function. Updated getDecodedToken to utilize this function for removing prefixes before handling tokens.
and invoice decoding functions. Add type annotations and cleanup code.
The isPowerOfTwo function in utils.ts was updated to include type annotations for better type safety. The return value now explicitly states the boolean type.
added 2 commits
April 12, 2024 17:08
The function bigIntStringify now returns a stringified value using JSON.stringify for non-bigint values.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added some comments to the function to make them more consistent with the others
The
isObjfunction in theutils.tsfile has been updated to provide more accurate type checking. Instead of simply checking if the value is an object, it now checks if it is an object with a string key and unknown value. This change improves the reliability of type checking in the codebase because in TypeScript, null is considered an object, which can lead to unexpected behavior.Made checkResponseError more concise