Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IQuerablePageReader<T>

Interface for data processing components that can query a page of data items.

Type parameters

  • T

Hierarchy

  • IQuerablePageReader

Index

Methods

Methods

getPageByQuery

  • getPageByQuery(correlation_id: string, query: string, paging: PagingParams, sort: SortParams, callback: function): void
  • Gets a page of data items using a query string.

    Parameters

    • correlation_id: string

      (optional) transaction id to trace execution through call chain.

    • query: string

      (optional) a query string

    • paging: PagingParams

      (optional) paging parameters

    • sort: SortParams

      (optional) sort parameters

    • callback: function

      callback function that receives list of items or error.

        • (err: any, page: DataPage<T>): void
        • Parameters

          • err: any
          • page: DataPage<T>

          Returns void

    Returns void

Generated using TypeDoc