Type Alias: CursorTableData<TRow>

type CursorTableData<TRow> = {
  invalidCursor?: boolean;
  items: TRow[];
  nextCursor: string | null;
  page?: never;
  pageCount?: never;
  pageSize?: never;
  paginationMode: "cursor";
  previousCursor: string | null;
  total?: never;
};

Defined in: shared/datatable/types.ts:344

A keyset/cursor result. Cursors are opaque to DataTable and may encode any server-owned boundary. Null cursors identify the first/final page.

Set invalidCursor when the requested cursor is stale or malformed. The DataTable replaces that URL state with the first-page URL and requests the data again.

Type ParametersCopy Anchor Link

PropertiesCopy Anchor Link

invalidCursor?Copy Anchor Link

optional invalidCursor?: boolean;

Defined in: shared/datatable/types.ts:349

itemsCopy Anchor Link

items: TRow[];

Defined in: shared/datatable/types.ts:346

nextCursorCopy Anchor Link

nextCursor: string | null;

Defined in: shared/datatable/types.ts:348

page?Copy Anchor Link

optional page?: never;

Defined in: shared/datatable/types.ts:351

pageCount?Copy Anchor Link

optional pageCount?: never;

Defined in: shared/datatable/types.ts:353

pageSize?Copy Anchor Link

optional pageSize?: never;

Defined in: shared/datatable/types.ts:352

paginationModeCopy Anchor Link

paginationMode: "cursor";

Defined in: shared/datatable/types.ts:345

previousCursorCopy Anchor Link

previousCursor: string | null;

Defined in: shared/datatable/types.ts:347

total?Copy Anchor Link

optional total?: never;

Defined in: shared/datatable/types.ts:350