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

    Function getUuidsPage

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

      Parameters

      Returns (
          qualifier: FreetextQualifier,
          cursor?: Nullable<string>,
          limit?: number | `${number}`,
      ) => Promise<Page<string>>

      a function for retrieving a paged array of report identifiers

        • (
              qualifier: FreetextQualifier,
              cursor?: Nullable<string>,
              limit?: number | `${number}`,
          ): Promise<Page<string>>

        • Returns an array of report identifiers for the provided page specifications.

          Parameters

          • qualifier: FreetextQualifier

            the limiter defining which identifiers 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_IDS_PAGE_LIMIT

            the maximum number of identifiers to return. Default is 10000.

          Returns Promise<Page<string>>

          a page of report identifiers for the provided specification

          InvalidArgumentError if no qualifier is provided or if the qualifier is invalid

          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

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

    Settings

    Member Visibility