Module: FinchAPI::Type::BasePage

Included in:
IndividualsPage, Page, ResponsesPage, SinglePage
Defined in:
lib/finch-api/type/base_page.rb

Overview

Examples:

if page.has_next?
  page = page.next_page
end
page.auto_paging_each do |access_token|
  puts(access_token)
end
access_tokens =
  page
  .to_enum
  .lazy
  .select { _1.object_id.even? }
  .map(&:itself)
  .take(2)
  .to_a

access_tokens => Array

Instance Method Summary collapse

Instance Method Details

#auto_paging_each ⇒ void

This method returns an undefined value.

Parameters:

  • blk (Proc) 


39
 
# File 'lib/finch-api/type/base_page.rb', line 39

def auto_paging_each(&) = (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:



52
53
54
55
56
 
# File 'lib/finch-api/type/base_page.rb', line 52

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

#next_page ⇒ FinchAPI::Type::BasePage

Returns:

Raises:



34
 
# File 'lib/finch-api/type/base_page.rb', line 34

def next_page = (raise NotImplementedError)

#next_page? ⇒ Boolean

Returns:

  • (Boolean) 


30
 
# File 'lib/finch-api/type/base_page.rb', line 30

def next_page? = (raise NotImplementedError)

#to_enum ⇒ Enumerable Also known as: enum_for

Returns:

  • (Enumerable) 


42
 
# File 'lib/finch-api/type/base_page.rb', line 42

def to_enum = super(:auto_paging_each)