Options
All
  • Public
  • Public/Protected
  • All
Menu

Type Parameters

  • T

Hierarchy

  • Promise<T>
    • PromiEvent

Index

Properties

[toStringTag]: string

Methods

  • catch<TResult>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>)): Promise<T | TResult>
  • Attaches a callback for only the rejection of the Promise.

    Type Parameters

    • TResult = never

    Parameters

    • Optional onrejected: ((reason: any) => TResult | PromiseLike<TResult>)

      The callback to execute when the Promise is rejected.

        • (reason: any): TResult | PromiseLike<TResult>
        • Parameters

          • reason: any

          Returns TResult | PromiseLike<TResult>

    Returns Promise<T | TResult>

    A Promise for the completion of the callback.

  • finally(onfinally?: (() => void)): Promise<T>
  • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

    Parameters

    • Optional onfinally: (() => void)

      The callback to execute when the Promise is settled (fulfilled or rejected).

        • (): void
        • Returns void

    Returns Promise<T>

    A Promise for the completion of the callback.

  • on(type: "sending", handler: ((payload: object) => void)): PromiEvent<T>
  • on(type: "sent", handler: ((payload: object) => void)): PromiEvent<T>
  • on(type: "transactionHash", handler: ((receipt: string) => void)): PromiEvent<T>
  • on(type: "receipt", handler: ((receipt: TransactionReceipt) => void)): PromiEvent<T>
  • on(type: "confirmation", handler: ((confNumber: number, receipt: TransactionReceipt, latestBlockHash?: string) => void)): PromiEvent<T>
  • on(type: "error", handler: ((error: Error) => void)): PromiEvent<T>
  • on(type: "error" | "sending" | "sent" | "transactionHash" | "receipt" | "confirmation", handler: ((error: string | object | Error | TransactionReceipt) => void)): PromiEvent<T>
  • Parameters

    • type: "sending"
    • handler: ((payload: object) => void)
        • (payload: object): void
        • Parameters

          • payload: object

          Returns void

    Returns PromiEvent<T>

  • Parameters

    • type: "sent"
    • handler: ((payload: object) => void)
        • (payload: object): void
        • Parameters

          • payload: object

          Returns void

    Returns PromiEvent<T>

  • Parameters

    • type: "transactionHash"
    • handler: ((receipt: string) => void)
        • (receipt: string): void
        • Parameters

          • receipt: string

          Returns void

    Returns PromiEvent<T>

  • Parameters

    Returns PromiEvent<T>

  • Parameters

    • type: "confirmation"
    • handler: ((confNumber: number, receipt: TransactionReceipt, latestBlockHash?: string) => void)
        • Parameters

          Returns void

    Returns PromiEvent<T>

  • Parameters

    • type: "error"
    • handler: ((error: Error) => void)
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns PromiEvent<T>

  • Parameters

    • type: "error" | "sending" | "sent" | "transactionHash" | "receipt" | "confirmation"
    • handler: ((error: string | object | Error | TransactionReceipt) => void)

    Returns PromiEvent<T>

  • once(type: "sending", handler: ((payload: object) => void)): PromiEvent<T>
  • once(type: "sent", handler: ((payload: object) => void)): PromiEvent<T>
  • once(type: "transactionHash", handler: ((transactionHash: string) => void)): PromiEvent<T>
  • once(type: "receipt", handler: ((receipt: TransactionReceipt) => void)): PromiEvent<T>
  • once(type: "confirmation", handler: ((confirmationNumber: number, receipt: TransactionReceipt, latestBlockHash?: string) => void)): PromiEvent<T>
  • once(type: "error", handler: ((error: Error) => void)): PromiEvent<T>
  • once(type: "error" | "sending" | "sent" | "transactionHash" | "receipt" | "confirmation", handler: ((error: string | object | Error | TransactionReceipt) => void)): PromiEvent<T>
  • Parameters

    • type: "sending"
    • handler: ((payload: object) => void)
        • (payload: object): void
        • Parameters

          • payload: object

          Returns void

    Returns PromiEvent<T>

  • Parameters

    • type: "sent"
    • handler: ((payload: object) => void)
        • (payload: object): void
        • Parameters

          • payload: object

          Returns void

    Returns PromiEvent<T>

  • Parameters

    • type: "transactionHash"
    • handler: ((transactionHash: string) => void)
        • (transactionHash: string): void
        • Parameters

          • transactionHash: string

          Returns void

    Returns PromiEvent<T>

  • Parameters

    Returns PromiEvent<T>

  • Parameters

    • type: "confirmation"
    • handler: ((confirmationNumber: number, receipt: TransactionReceipt, latestBlockHash?: string) => void)
        • Parameters

          Returns void

    Returns PromiEvent<T>

  • Parameters

    • type: "error"
    • handler: ((error: Error) => void)
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns PromiEvent<T>

  • Parameters

    • type: "error" | "sending" | "sent" | "transactionHash" | "receipt" | "confirmation"
    • handler: ((error: string | object | Error | TransactionReceipt) => void)

    Returns PromiEvent<T>

  • then<TResult1, TResult2>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>), onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>)): Promise<TResult1 | TResult2>
  • Attaches callbacks for the resolution and/or rejection of the Promise.

    Type Parameters

    • TResult1 = T

    • TResult2 = never

    Parameters

    • Optional onfulfilled: ((value: T) => TResult1 | PromiseLike<TResult1>)

      The callback to execute when the Promise is resolved.

        • (value: T): TResult1 | PromiseLike<TResult1>
        • Parameters

          • value: T

          Returns TResult1 | PromiseLike<TResult1>

    • Optional onrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>)

      The callback to execute when the Promise is rejected.

        • (reason: any): TResult2 | PromiseLike<TResult2>
        • Parameters

          • reason: any

          Returns TResult2 | PromiseLike<TResult2>

    Returns Promise<TResult1 | TResult2>

    A Promise for the completion of which ever callback is executed.

Generated using TypeDoc