@medic/cht-datasource
    Preparing search index...

    Function getPage

    • Returns a function for retrieving a paged array of places from the given data context.

      Parameters

      Returns (
          placeType: ContactTypeQualifier,
          cursor?: Nullable<string>,
          limit?: number | `${number}`,
      ) => Promise<Page<Place.v1.Place>>

      a function for retrieving a paged array of places

        • (
              placeType: ContactTypeQualifier,
              cursor?: Nullable<string>,
              limit?: number | `${number}`,
          ): Promise<Page<Place.v1.Place>>

        • Returns an array of places for the provided page specifications.

          Parameters

          • placeType: ContactTypeQualifier

            the type of places to return

          • cursor: Nullable<string> = null

            the token identifying which page to retrieve. A null value indicates the first page should be returned. Subsequent pages can be retrieved by providing the cursor returned with the previous page.

          • limit: number | `${number}` = DEFAULT_DOCS_PAGE_LIMIT

            the maximum number of places to return. Default is 100.

          Returns Promise<Page<Place.v1.Place>>

          a page of places for the provided specification

          InvalidArgumentError if no type is provided or if the type is not for a place

          InvalidArgumentError if the provided limit value is <=0

          InvalidArgumentError if the provided cursor is not a valid page token or null

      Error if a data context is not provided

      getAll which provides the same data, but without having to manually account for paging

    Settings

    Member Visibility