Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PagedResult<TOptions, TResponse, TPage>

Package version

an interface that describes how to communicate with the service and how to build a page of items.

Type parameters

  • TOptions: Record<string, any>

  • TResponse

  • TPage

Hierarchy

  • PagedResult

Index

Properties

Properties

Optional buildPage

buildPage: undefined | ((response: TResponse) => TPage)

A method to build a page of items from the response.

Optional getNextLink

getNextLink: undefined | ((response: TResponse) => string | undefined)

A method that extracts the link to the next page of results from the response.

sendGetRequest

sendGetRequest: (path: string, options: TOptions) => Promise<TResponse>

A method that send a GET request to the service and returns a response.

Type declaration

    • (path: string, options: TOptions): Promise<TResponse>

    • Parameters

      • path: string
      • options: TOptions

      Returns Promise<TResponse>

Generated using TypeDoc