From 88f39d7e9de42a21b30545cac7c4134c08991d64 Mon Sep 17 00:00:00 2001 From: Sugat Bajracharya <30311933+sugat009@users.noreply.github.com> Date: Thu, 8 Aug 2024 13:36:41 +0545 Subject: [PATCH] Update shared-libs/cht-datasource/src/libs/core.ts Co-authored-by: Joshua Kuestersteffen --- shared-libs/cht-datasource/src/libs/core.ts | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/shared-libs/cht-datasource/src/libs/core.ts b/shared-libs/cht-datasource/src/libs/core.ts index ebdedc95b46..9ff684027bd 100644 --- a/shared-libs/cht-datasource/src/libs/core.ts +++ b/shared-libs/cht-datasource/src/libs/core.ts @@ -113,7 +113,12 @@ export abstract class AbstractDataContext implements DataContext { readonly bind = (fn: (ctx: DataContext) => T): T => fn(this); } -/** @internal */ +/** + * Represents a page of results. The `data` array contains the results for this page. The `cursor` field contains a + * key that can be used to fetch the next page of results. If no `cursor` value is returned, there are no additional + * results available. (Note that no assumptions should be made about the _contents_ of the cursor string.) + * @typeParam T the type of the data in the page + */ export interface Page { readonly data: T[]; readonly cursor: string;