/* * @license Apache-2.0 * * Copyright (c) 2019 The Stdlib Authors. * * 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. */ // TypeScript Version: 4.1 /// import { Iterator } from '@stdlib/types/iter'; /** * Returns the nth iterated value. * * ## Notes * * - If `n` exceeds the total number of iterations, the function returns `undefined`. * * @param iterator - input iterator * @param n - iteration number * @returns nth iterated value * * @example * var array2iterator = require( '@stdlib/array/to-iterator' ); * * var it = array2iterator( [ 0, 0, 1, 0, 0 ] ); * * var v = iterNth( it, 3 ); * // returns 1 */ declare function iterNth( iterator: Iterator, n: number ): any; // EXPORTS // export = iterNth;