wink-nlp/src/api/col-get-item.js

Developer friendly Natural Language Processing ✨

//     wink-nlp
//
//     Copyright (C) GRAYPE Systems Private Limited
//
//     This file is part of “wink-nlp”.
//
//     Permission is hereby granted, free of charge, to any
//     person obtaining a copy of this software and
//     associated documentation files (the "Software"), to
//     deal in the Software without restriction, including
//     without limitation the rights to use, copy, modify,
//     merge, publish, distribute, sublicense, and/or sell
//     copies of the Software, and to permit persons to
//     whom the Software is furnished to do so, subject to
//     the following conditions:
//
//     The above copyright notice and this permission notice
//     shall be included in all copies or substantial
//     portions of the Software.
//
//     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
//     ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
//     TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
//     PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
//     THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
//     DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
//     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
//     CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//     DEALINGS IN THE SOFTWARE.

//

// ## colGetItemAt
/**
 * Obtains an item at the specified index from a collection.
 * @param  {number}   k      Relative index of the required item.
 * @param  {number}   start  The start index of collection.
 * @param  {number}   end    The end index of the collection.
 * @param  {function} itemFn Item function to create chainable-methods of the item.
 * @return {object}          Object containing the applicable chainable-methods
 *                           for the item found at `k`; otherwise `undefined`.
 * @private
 */
var colGetItemAt = function ( k, start, end, itemFn ) {
  // To handle relative indexing, compute actual `k` by adding `start`.
  var ak = k + start;
  if ( ak < start || ak > end ) {
    throw Error( `wink-nlp: ${k} is an invalid or out of bounds index.`);
  } else return itemFn( ak );
}; // colGetItemAt()

module.exports = colGetItemAt;