Pagination#

The Afosto API uses Relay-style cursor-based pagination for all list fields.

How it works#

List fields return a Connection type with:

edges — array of result items wrapped in an Edge type
pageInfo — metadata about the current page

PageInfo#

Name	Type	Required	Description
`hasNextPage`	Boolean!	Required	Whether there are more items after this page
`hasPreviousPage`	Boolean!	Required	Whether there are more items before this page
`startCursor`	String	Optional	Cursor of the first item in this page
`endCursor`	String	Optional	Cursor of the last item in this page

Edge#

Each edge wraps a single result item with its cursor:

Name	Type	Required	Description
`cursor`	String!	Required	Opaque cursor for this item — pass to after or before
`node`	T!	Required	The item itself (type depends on the query)

Fetching the first page#

query {
  products(first: 20) {
    pageInfo {
      hasNextPage
      endCursor
    }
    edges {
      node {
        id
        name
      }
    }
  }
}

Fetching the next page#

Use the endCursor from the previous response as the after argument:

query {
  products(first: 20, after: "cursor_from_previous_response") {
    pageInfo {
      hasNextPage
      endCursor
    }
    edges {
      node {
        id
        name
      }
    }
  }
}

Arguments#

All paginated list fields accept these arguments:

Name	Type	Required	Description
`first`	Int	Optional	Number of items to fetch from the start (forward pagination)
`after`	String	Optional	Cursor to start after — use endCursor from the previous page
`last`	Int	Optional	Number of items to fetch from the end (backward pagination)
`before`	String	Optional	Cursor to fetch before — use startCursor from the previous page

Iterating all pages#

async function fetchAllProducts() {
  let hasNextPage = true
  let cursor: string | null = null
  const products = []

  while (hasNextPage) {
    const result = await query({
      query: GET_PRODUCTS,
      variables: { first: 100, after: cursor },
    })

    products.push(...result.products.edges.map((e) => e.node))
    hasNextPage = result.products.pageInfo.hasNextPage
    cursor = result.products.pageInfo.endCursor
  }

  return products
}