Module: XTwitterScraper::Internal::Type::BasePage Private

Defined in:
lib/x_twitter_scraper/internal/type/base_page.rb,
sig/x_twitter_scraper/internal/type/base_page.rbs

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

This module provides a base implementation for paginated responses in the SDK.

Instance Method Summary collapse

Instance Method Details

#auto_paging_each(&blk) {|, arg0| ... } ⇒ void

This method returns an undefined value.

Parameters:

  • blk (Proc)

Yields:

Yield Parameters:

  • (generic<Elem>)
  • arg0 (Elem)

Yield Returns:

  • (void) 


35
 
# File 'lib/x_twitter_scraper/internal/type/base_page.rb', line 35

def auto_paging_each(&blk) = (raise NotImplementedError)

#initialize(client:, req:, headers:, page_data:) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:



48
49
50
51
52
53
 
# File 'lib/x_twitter_scraper/internal/type/base_page.rb', line 48

def initialize(client:, req:, headers:, page_data:)
  @client = client
  @req = req
  @model = req.fetch(:model)
  super()
end

#next_page ⇒ self

Returns:

  • (self)

Raises:



27
 
# File 'lib/x_twitter_scraper/internal/type/base_page.rb', line 27

def next_page = (raise NotImplementedError)

#next_page? ⇒ Boolean

Returns:



21
 
# File 'lib/x_twitter_scraper/internal/type/base_page.rb', line 21

def next_page? = (raise NotImplementedError)

#to_enum ⇒ Enumerable<generic<Elem>> Also known as: enum_for

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Enumerable<generic<Elem>>) 


38
 
# File 'lib/x_twitter_scraper/internal/type/base_page.rb', line 38

def to_enum = super(:auto_paging_each)