• Preparing search index...
  • The search index is not available
@planet-a/affinity-node
  • @planet-a/affinity-node
  • v1
  • CreateSearchIteratorFn
  • createSearchIteratorFn

Function createSearchIteratorFn

  • createSearchIteratorFn<FN, PAGED_REQUEST, PAGED_RESPONSE, PAYLOAD_KEY, SINGLE_RESPONSE>(searchFn, key): ((params: Omit<Parameters<FN>[0], keyof PagedRequest> & Omit<PAGED_REQUEST, "page_token">) => AsyncGenerator<Unwrapped<FN, PAYLOAD_KEY>>)
  • Type Parameters

    • FN extends ((r: PAGED_REQUEST) => Promise<PAGED_RESPONSE>)
    • PAGED_REQUEST extends PagedRequest
    • PAGED_RESPONSE extends PagedResponse & Record<PAYLOAD_KEY, SINGLE_RESPONSE[]>
    • PAYLOAD_KEY extends string = Exclude<keyof PAGED_RESPONSE, "next_page_token"> & string
    • SINGLE_RESPONSE = object

    Parameters

    • searchFn: FN
    • key: PAYLOAD_KEY

    Returns ((params: Omit<Parameters<FN>[0], keyof PagedRequest> & Omit<PAGED_REQUEST, "page_token">) => AsyncGenerator<Unwrapped<FN, PAYLOAD_KEY>>)

      • (params): AsyncGenerator<Unwrapped<FN, PAYLOAD_KEY>>
      • Parameters

        • params: Omit<Parameters<FN>[0], keyof PagedRequest> & Omit<PAGED_REQUEST, "page_token">

        Returns AsyncGenerator<Unwrapped<FN, PAYLOAD_KEY>>

    • Defined in src/v1/create_search_iterator_fn.ts:15

Settings

Member Visibility
@planet-a/affinity-node
  • Loading...

Generated using TypeDoc