Type Alias EntityRetriever<T>

type EntityRetriever<T> = {
    retrieve: (
        limit?: number,
        cursor?: OptionalPageCursor,
    ) => Promise<PaginatedEntity<T>>;
}

Type Parameters

T

Index

Properties

Properties

retrieve

retrieve: (
limit?: number,
cursor?: OptionalPageCursor,
) => Promise<PaginatedEntity<T>>

Retrieves a page of the data

Type Declaration

- (limit?: number, cursor?: OptionalPageCursor): Promise<PaginatedEntity<T>>
- Parameters
  - Optionallimit: number
    maximum number of entries in the returned page
  - Optionalcursor: OptionalPageCursor
    where the page starts
  Returns Promise<PaginatedEntity<T>>
  a page staring at cursor location and containing at most limit number of items.