Options
All
  • Public
  • Public/Protected
  • All
Menu

Module ValidateParameters

Index

Functions

Functions

validateAddress

  • validateAddress(address: string, integratedAddressAllowed: boolean, config?: IConfig): Promise<boolean>

  • Verifies that the address given is valid.

    Parameters

    • address: string

      The address to validate.

    • integratedAddressAllowed: boolean

      Should an integrated address be allowed?

    • Optional config: IConfig

    Returns Promise<boolean>

    Returns true if the address is valid, otherwise returns false

validateAddresses

  • validateAddresses(addresses: string[], integratedAddressesAllowed: boolean, config?: IConfig): Promise<WalletError>

  • Parameters

    • addresses: string[]

      The addresses to validate

    • integratedAddressesAllowed: boolean

      Should we allow integrated addresses?

    • config: IConfig = ...

      Verifies that the addresses given are valid.

    Returns Promise<WalletError>

    Returns SUCCESS if valid, otherwise a WalletError describing the error

validatePaymentID

  • validatePaymentID(paymentID: string, allowEmptyString?: boolean): WalletError

  • Validates the payment ID is valid (or an empty string)

    Parameters

    • paymentID: string
    • allowEmptyString: boolean = true

    Returns WalletError

    Returns SUCCESS if valid, otherwise a WalletError describing the error

Generated using TypeDoc