Class ChannelListRequest

constructor

• new ChannelListRequest(
      rev: RevClient,
      start?: number,
      options?: Channel.SearchOptions,
  ): ChannelListRequest

• Parameters

  • rev: RevClient
  • start: number = 0
  • options: Channel.SearchOptions = {}

  Returns ChannelListRequest

current

currentPage

done

options

total

[asyncIterator]

• "[asyncIterator]"(): AsyncGenerator<Channel.SearchHit, void>

• Returns AsyncGenerator<Channel.SearchHit, void>

exec

• exec(): Promise<Channel.SearchHit[]>

• Go through all pages of results and return as an array. TIP: Use the {maxResults} option to limit the maximum number of results

  Returns Promise<Channel.SearchHit[]>

nextPage

• nextPage(): Promise<
      {
          current: number;
          done: boolean;
          items: Channel.SearchHit[];
          total: number;
      },
  >

• Returns Promise<
      {
          current: number;
          done: boolean;
          items: Channel.SearchHit[];
          total: number;
      },
  >