Function setAlias

setAlias(payload): Promise<boolean>
Instead of using HOPR address, we can assign HOPR address to a specific name called alias. Give an address a more memorable alias and use it instead of Hopr address. Aliases are kept locally and are not saved or shared on the network.
Parameters
- payload: {
      alias: string;
      apiEndpoint: string | URL;
      apiToken: string;
      destination?: string;
      peerId?: string;
      timeout?: number;
  }
  - alias: string
  - apiEndpoint: string | URL
    The API endpoint for authentication.
  - apiToken: string
    The API token for authentication.
  - Optional destination?: string
  - Optional peerId?: string
  - Optional timeout?: number
    optional timeout for the requests
Returns Promise<boolean>
A Promise that resolves to true if alias successfully linked to peerId.

Throws
An error that occurred while processing the request.
- Defined in src/api/aliases/setAlias.ts:20