searchAliases method

Future<Iterable<AliasDoc>> searchAliases(
  1. String handlePrefix, [
  2. int pageSize = 20
])

Searches for aliases based on a handle prefix.

This method retrieves a list of aliases whose handles start with the provided prefix.

Parameters:

  • handlePrefix (required): The prefix string to search for in alias handles.
  • pageSize (optional): The maximum number of aliases to return in the response. Defaults to 20.

Returns:

Implementation

Future<Iterable<AliasDoc>> searchAliases(
  String handlePrefix, [
  int pageSize = 20,
]) async {
  final request =
      SearchAliasesRequest(handlePrefix: handlePrefix, pageSize: pageSize);
  final response =
      await _client.searchAliases(request, options: await _fetchOptions());
  final entries = response.aliases.map(AliasDoc.new);
  return entries;
}