/*! Copyright 2018 Ron Buckton (rbuckton@chronicles.org) Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ /** @module "iterable-query/fn" */ import { Queryable } from "../types"; import { Equaler } from '@esfx/equatable'; /** * Creates an [[Iterable]] for the correlated elements of two [[Queryable]] objects. * * @param outer A [[Queryable]] object. * @param inner A [[Queryable]] object. * @param outerKeySelector A callback used to select the key for an element in `outer`. * @param innerKeySelector A callback used to select the key for an element in `inner`. * @param resultSelector A callback used to select the result for the correlated elements. * @param keyEqualer An [[Equaler]] object used to compare key equality. * @category Join */ export declare function join(outer: Queryable, inner: Queryable, outerKeySelector: (element: O) => K, innerKeySelector: (element: I) => K, resultSelector: (outer: O, inner: I) => R, keyEqualer?: Equaler): Iterable; //# sourceMappingURL=join.d.ts.map