mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-10-23 11:46:13 +02:00
14d85b1332
A few inconsistencies in JSDoc formatting have been fixed throughout the project. Many issues remain; these were just the few things that were easy to fix with a regular expression. The changes include: * Using lower-case for primitive types, but capitalizing non-primitive types * Separating the parameter identifier and the description with a dash * Omitting a dash between the return type and the return description * Ensuring the parameter type is first and the identifier is second (in a few places it was backwards) * Using square brackets to denote when a parameter is optional, rather than putting "(optional)" in the parameter description * Including a type and identifier with every parameter * Fixing inconsistent spacing, except where it's used for alignment * Remove incorrectly formatted `@deprecated` tags that reference non- existent properties * Remove lone comment block without accompanying function Additionally, one parameter was renamed for clarity.
24 lines
1.0 KiB
JavaScript
24 lines
1.0 KiB
JavaScript
import { useMemo } from 'react'
|
|
import { getTokenData } from '../helpers/utils/transactions.util'
|
|
|
|
/**
|
|
* useTokenData
|
|
* Given the data string from txParams return a decoded object of the details of the
|
|
* transaction data.
|
|
* @param {string} [transactionData] - Raw data string from token transaction
|
|
* @param {boolean} [isTokenTransaction] - Due to the nature of hooks, it isn't possible
|
|
* to conditionally call this hook. This flag will
|
|
* force this hook to return null if it set as false
|
|
* which indicates the transaction is not associated
|
|
* with a token.
|
|
* @return {Object} - Decoded token data
|
|
*/
|
|
export function useTokenData(transactionData, isTokenTransaction = true) {
|
|
return useMemo(() => {
|
|
if (!isTokenTransaction || !transactionData) {
|
|
return null
|
|
}
|
|
return getTokenData(transactionData)
|
|
}, [isTokenTransaction, transactionData])
|
|
}
|