@kingjs/linq.single

Returns the only element of a sequence that satisfies a specified condition.

Usage

Return the single odd number in 0, 1, 2 like this:

var singleOrUndefined = require('@kingjs/linq.single');
var sequence = require('@kingjs/enumerable.create');

function isOdd(x) { 
  return x % 2 == 1; 
}

singleOrUndefined.call(sequence(0, 1, 2), isOdd);

result:

1

API

declare function single(
  this: Enumerable,
  predicate?: function(x): boolean
): any

Interfaces

• Enumerable: See @kingjs/enumerable.define.

Parameters

• this: The enumerable to search for a single element.
• predicate: The predicate with which to test elements.

Return Value

A single element that satisfies predicate else, if more than one or no element satisfies predicate, than throws.

Install

With npm installed, run

$ npm install @kingjs/linq.single

Acknowledgments

Like Element.Single.

License

MIT