/*!
  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, OrderedIterable, HierarchyIterable, OrderedHierarchyIterable } from "../types";
import { Comparison, Comparer } from 'equatable';
/**
 * Creates an [[OrderedHierarchyIterable]] whose elements are sorted in ascending order by the provided key.
 *
 * @param source A [[HierarchyIterable]] object.
 * @param keySelector A callback used to select the key for an element.
 * @param comparison An optional callback used to compare two keys.
 * @category Order
 */
export declare function orderBy<TNode, T extends TNode, K>(source: HierarchyIterable<TNode, T>, keySelector: (element: T) => K, keyComparer?: Comparison<K> | Comparer<K>): OrderedHierarchyIterable<TNode, T>;
/**
 * Creates an [[OrderedIterable]] whose elements are sorted in ascending order by the provided key.
 *
 * @param source A [[Queryable]] object.
 * @param keySelector A callback used to select the key for an element.
 * @param keyComparer An optional callback used to compare two keys.
 * @category Order
 */
export declare function orderBy<T, K>(source: Queryable<T>, keySelector: (element: T) => K, keyComparer?: Comparison<K> | Comparer<K>): OrderedIterable<T>;
/**
 * Creates an [[OrderedHierarchyIterable]] whose elements are sorted in descending order by the provided key.
 *
 * @param source A [[HierarchyIterable]] object.
 * @param keySelector A callback used to select the key for an element.
 * @param keyComparer An optional callback used to compare two keys.
 * @category Order
 */
export declare function orderByDescending<TNode, T extends TNode, K>(source: HierarchyIterable<TNode, T>, keySelector: (element: T) => K, keyComparer?: Comparison<K> | Comparer<K>): OrderedHierarchyIterable<TNode, T>;
/**
 * Creates an [[OrderedIterable]] whose elements are sorted in descending order by the provided key.
 *
 * @param source A [[Queryable]] object.
 * @param keySelector A callback used to select the key for an element.
 * @param keyComparer An optional callback used to compare two keys.
 * @category Order
 */
export declare function orderByDescending<T, K>(source: Queryable<T>, keySelector: (element: T) => K, keyComparer?: Comparison<K> | Comparer<K>): OrderedIterable<T>;
/**
 * Creates a subsequent [[OrderedHierarchyIterable]] whose elements are also sorted in ascending order by the provided key.
 *
 * @param source An [[OrderedHierarchyIterable]] object.
 * @param keySelector A callback used to select the key for an element.
 * @param keyComparer An optional callback used to compare two keys.
 * @category Order
 */
export declare function thenBy<TNode, T extends TNode, K>(source: OrderedHierarchyIterable<TNode, T>, keySelector: (element: T) => K, keyComparer?: Comparison<K> | Comparer<K>): OrderedHierarchyIterable<TNode, T>;
/**
 * Creates a subsequent [[OrderedIterable]] whose elements are also sorted in ascending order by the provided key.
 *
 * @param source An [[OrderedIterable]] object.
 * @param keySelector A callback used to select the key for an element.
 * @param keyComparer An optional callback used to compare two keys.
 * @category Order
 */
export declare function thenBy<T, K>(source: OrderedIterable<T>, keySelector: (element: T) => K, keyComparer?: Comparison<K> | Comparer<K>): OrderedIterable<T>;
/**
 * Creates a subsequent [[OrderedHierarchyIterable]] whose elements are also sorted in descending order by the provided key.
 *
 * @param source An [[OrderedHierarchyIterable]] object.
 * @param keySelector A callback used to select the key for an element.
 * @param keyComparer An optional callback used to compare two keys.
 * @category Order
 */
export declare function thenByDescending<TNode, T extends TNode, K>(source: OrderedHierarchyIterable<TNode, T>, keySelector: (element: T) => K, keyComparer?: Comparison<K> | Comparer<K>): OrderedHierarchyIterable<TNode, T>;
/**
 * Creates a subsequent [[OrderedIterable]] whose elements are also sorted in descending order by the provided key.
 *
 * @param source An [[OrderedIterable]] object.
 * @param keySelector A callback used to select the key for an element.
 * @param keyComparer An optional callback used to compare two keys.
 * @category Order
 */
export declare function thenByDescending<T, K>(source: OrderedIterable<T>, keySelector: (element: T) => K, keyComparer?: Comparison<K> | Comparer<K>): OrderedIterable<T>;
//# sourceMappingURL=orderBy.d.ts.map