Add to doc comment why a block might not be returned to the caller

2018-09-24 15:14:07 +01:00
parent 5d88a56452
commit 311b925919
1 changed files with 1 additions and 0 deletions
--- a/packages/web3-wrapper/src/web3_wrapper.ts
+++ b/packages/web3-wrapper/src/web3_wrapper.ts
@@ -330,6 +330,7 @@ export class Web3Wrapper {
     * Fetch a specific Ethereum block without transaction data
     * @param blockParam The block you wish to fetch (blockHash, blockNumber or blockLiteral)
     * @returns The requested block without transaction data, or undefined if block was not found
+     * (e.g the node isn't fully synced, there was a block re-org and the requested block was uncles, etc...)
     */
    public async getBlockIfExistsAsync(
        blockParam: string | BlockParam,