/*!
  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, HierarchyIterable } from "../types";
/**
 * Creates a tuple whose first element is an [[Iterable]] containing the first span of
 * elements that match the supplied predicate, and whose second element is an [[Iterable]]
 * containing the remaining elements.
 *
 * The first [[Iterable]] is eagerly evaluated, while the second [[Iterable]] is lazily
 * evaluated.
 *
 * @param source A [[Queryable]] object.
 * @param predicate The predicate used to match elements.
 * @category Scalar
 */
export declare function span<TNode, T extends TNode, U extends T>(source: HierarchyIterable<TNode, T>, predicate: (element: T, offset: number) => element is U): [HierarchyIterable<TNode, U>, HierarchyIterable<TNode, T>];
/**
 * Creates a tuple whose first element is an [[Iterable]] containing the first span of
 * elements that match the supplied predicate, and whose second element is an [[Iterable]]
 * containing the remaining elements.
 *
 * The first [[Iterable]] is eagerly evaluated, while the second [[Iterable]] is lazily
 * evaluated.
 *
 * @param source A [[Queryable]] object.
 * @param predicate The predicate used to match elements.
 * @category Scalar
 */
export declare function span<TNode, T extends TNode>(source: HierarchyIterable<TNode, T>, predicate: (element: T, offset: number) => boolean): [HierarchyIterable<TNode, T>, HierarchyIterable<TNode, T>];
/**
 * Creates a tuple whose first element is an [[Iterable]] containing the first span of
 * elements that match the supplied predicate, and whose second element is an [[Iterable]]
 * containing the remaining elements.
 *
 * The first [[Iterable]] is eagerly evaluated, while the second [[Iterable]] is lazily
 * evaluated.
 *
 * @param source A [[Queryable]] object.
 * @param predicate The predicate used to match elements.
 * @category Scalar
 */
export declare function span<T, U extends T>(source: Queryable<T>, predicate: (element: T, offset: number) => element is U): [Iterable<U>, Iterable<T>];
/**
 * Creates a tuple whose first element is an [[Iterable]] containing the first span of
 * elements that match the supplied predicate, and whose second element is an [[Iterable]]
 * containing the remaining elements.
 *
 * The first [[Iterable]] is eagerly evaluated, while the second [[Iterable]] is lazily
 * evaluated.
 *
 * @param source A [[Queryable]] object.
 * @param predicate The predicate used to match elements.
 * @category Scalar
 */
export declare function span<T>(source: Queryable<T>, predicate: (element: T, offset: number) => boolean): [Iterable<T>, Iterable<T>];
//# sourceMappingURL=span.d.ts.map