Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Type Alias: PaginatedResponse

type PaginatedResponse<T> = {
  pageInfo?: {
     endCursor: string | null;
     hasNextPage: boolean;
     hasPreviousPage: boolean;
     startCursor: string | null;
  };
  results: T[];
  total: number;
};

Paginated Response

Type Parameters

T

T

Properties

Property
Type
Description

pageInfo?

{ endCursor: string | null; hasNextPage: boolean; hasPreviousPage: boolean; startCursor: string | null; }

-

pageInfo.endCursor

string | null

When paginating forwards, the cursor to continue.

pageInfo.hasNextPage

boolean

When paginating forwards, are there more items?

pageInfo.hasPreviousPage

boolean

When paginating backwards, are there more items?

pageInfo.startCursor

string | null

When paginating backwards, the cursor to continue.

results

T[]

A list of nodes.

total

number

The total amount of items available.

Last updated

Was this helpful?