View Source CensysEx.Paginate (censys_ex v2.0.1)

CensysEx.Paginate implements a wrapper for cursor paginated APIs

Summary

Types

next_page_fn()

function that takes in a keyword list of query params and returns either a map of results or an error

result_extractor()

function that takes in the internal results of paginated API calls, returning a [any]

t()

struct to maintain the state of a paginated api call

Functions

stream(client, next_fn, results_fn, params \\ Keyword.new())

Types

Link to this type

next_page_fn()

View Source 
@type next_page_fn() :: (CensysEx.API.t(), Keyword.t() -> CensysEx.result())

function that takes in a keyword list of query params and returns either a map of results or an error

Link to this type

result_extractor()

View Source 
@type result_extractor() :: (t() -> [any()])

function that takes in the internal results of paginated API calls, returning a [any]

Link to this type

t()

View Source 
@type t() :: %CensysEx.Paginate{
  client: CensysEx.API.t(),
  cursor: String.t(),
  next_fn: next_page_fn(),
  page: integer(),
  params: Keyword.t(),
  results: map(),
  results_fn: result_extractor()
}

struct to maintain the state of a paginated api call

Functions

Link to this function

stream(client, next_fn, results_fn, params \\ Keyword.new())

View Source 
@spec stream(CensysEx.API.t(), next_page_fn(), result_extractor(), keyword()) ::
  CensysEx.result_stream(any())