• Correlates the elements of two sequences based on matching keys.

    Type Parameters

    • TOuter

      The type of the elements of the first async-iterable sequence.

    • TInner

      The type of the elements of the second async-iterable sequence.

    • TKey

      The type of the keys returned by the key selector functions.

    • TResult

      The type of the result elements.

    Parameters

    • inner: AsyncIterable<TInner>

      The async-enumerable sequence to join to the first sequence.

    • outerSelector: ((value, signal?) => TKey | Promise<TKey>)

      A function to extract the join key from each element of the first sequence.

        • (value, signal?): TKey | Promise<TKey>
        • Parameters

          • value: TOuter
          • Optional signal: AbortSignal

          Returns TKey | Promise<TKey>

    • innerSelector: ((value, signal?) => TKey | Promise<TKey>)

      A function to extract the join key from each element of the second sequence.

        • (value, signal?): TKey | Promise<TKey>
        • Parameters

          • value: TInner
          • Optional signal: AbortSignal

          Returns TKey | Promise<TKey>

    • resultSelector: ((outer, inner, signal?) => TResult | Promise<TResult>)

      A function to create a result element from two matching elements.

        • (outer, inner, signal?): TResult | Promise<TResult>
        • Parameters

          • outer: TOuter
          • inner: TInner
          • Optional signal: AbortSignal

          Returns TResult | Promise<TResult>

    Returns OperatorAsyncFunction<TOuter, TResult>

    An async-iterable sequence that has elements that are obtained by performing an inner join on two sequences.

Generated using TypeDoc