Pagination Pseudocode

gistfile1.txt

#####
# Interfaces describing the two kinds of cursor based paginated inputs
#####

interface TimePaginator {
  Cursor Date.Time
}

interface SkipLimitPaginator {
  Skip int
  Limit int
}

#####
# Types to capture pagination input
#####

type TimePaginationInput {
  Cursor      Date.Time  # Start before or after this timestamp depending on 
  Limit       int        # Limit the number of results to be returned.
  Sort        string     # Default: CHRONOLOGICAL, accepts REVERSE_CHRONOLOGICAL
}

type SkipLimitPaginationInput {
  Skip        int        # Start before or after this timestamp depending on 
  Limit       int        # Limit the number of results to be returned.
  Sort        string     # Default: CHRONOLOGICAL, accepts REVERSE_CHRONOLOGICAL
}


#####
# Examples 
#####

# Comment by articles will probably be a time based query since:
#  comments are constantly coming in
#  users are expecting the "next" comments
type CommentsByArticleInput {

  TimePaginationInput    
  ArticleID   int        # Article to search on

}