/*--------------------------------------------------------------------------
|
* linq-vsdoc.js - LINQ for JavaScript
|
* ver 2.2.0.2 (Jan. 21th, 2011)
|
*
|
* created and maintained by neuecc <ils@neue.cc>
|
* licensed under Microsoft Public License(Ms-PL)
|
* http://neue.cc/
|
* http://linqjs.codeplex.com/
|
*--------------------------------------------------------------------------*/
|
Enumerable = (function ()
|
{
|
var Enumerable = function (getEnumerator)
|
{
|
this.GetEnumerator = getEnumerator;
|
}
|
|
Enumerable.Choice = function (Params_Contents)
|
{
|
/// <summary>Random choice from arguments.
|
/// Ex: Choice(1,2,3) - 1,3,2,3,3,2,1...</summary>
|
/// <param type="T" name="Params_Contents" parameterArray="true">Array or Params Contents</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.Cycle = function (Params_Contents)
|
{
|
/// <summary>Cycle Repeat from arguments.
|
/// Ex: Cycle(1,2,3) - 1,2,3,1,2,3,1,2,3...</summary>
|
/// <param type="T" name="Params_Contents" parameterArray="true">Array or Params Contents</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.Empty = function ()
|
{
|
/// <summary>Returns an empty Enumerable.</summary>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.From = function (obj)
|
{
|
/// <summary>
|
/// Make Enumerable from obj.
|
/// 1. null = Enumerable.Empty().
|
/// 2. Enumerable = Enumerable.
|
/// 3. Number/Boolean = Enumerable.Repeat(obj, 1).
|
/// 4. String = to CharArray.(Ex:"abc" => "a","b","c").
|
/// 5. Object/Function = to KeyValuePair(except function) Ex:"{a:0}" => (.Key=a, .Value=0).
|
/// 6. Array or ArrayLikeObject(has length) = to Enumerable.
|
/// 7. JScript's IEnumerable = to Enumerable(using Enumerator).
|
/// </summary>
|
/// <param name="obj">object</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.Return = function (element)
|
{
|
/// <summary>Make one sequence. This equals Repeat(element, 1)</summary>
|
/// <param name="element">element</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.Matches = function (input, pattern, flags)
|
{
|
/// <summary>Global regex match and send regexp object.
|
/// Ex: Matches((.)z,"0z1z2z") - $[1] => 0,1,2</summary>
|
/// <param type="String" name="input">input string</param>
|
/// <param type="RegExp/String" name="pattern">RegExp or Pattern string</param>
|
/// <param type="Optional:String" name="flags" optional="true">If pattern is String then can use regexp flags "i" or "m" or "im"</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.Range = function (start, count, step)
|
{
|
/// <summary>Generates a sequence of integral numbers within a specified range.
|
/// Ex: Range(1,5) - 1,2,3,4,5</summary>
|
/// <param type="Number" integer="true" name="start">The value of the first integer in the sequence.</param>
|
/// <param type="Number" integer="true" name="count">The number of sequential integers to generate.</param>
|
/// <param type="Optional:Number" integer="true" name="step" optional="true">Step of generate number.(Ex:Range(0,3,5) - 0,5,10)</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.RangeDown = function (start, count, step)
|
{
|
/// <summary>Generates a sequence of integral numbers within a specified range.
|
/// Ex: RangeDown(5,5) - 5,4,3,2,1</summary>
|
/// <param type="Number" integer="true" name="start">The value of the first integer in the sequence.</param>
|
/// <param type="Number" integer="true" name="count">The number of sequential integers to generate.</param>
|
/// <param type="Optional:Number" integer="true" name="step" optional="true">Step of generate number.(Ex:RangeDown(0,3,5) - 0,-5,-10)</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.RangeTo = function (start, to, step)
|
{
|
/// <summary>Generates a sequence of integral numbers.
|
/// Ex: RangeTo(10,12) - 10,11,12 RangeTo(0,-2) - 0, -1, -2</summary>
|
/// <param type="Number" integer="true" name="start">start integer</param>
|
/// <param type="Number" integer="true" name="to">to integer</param>
|
/// <param type="Optional:Number" integer="true" name="step" optional="true">Step of generate number.(Ex:RangeTo(0,7,3) - 0,3,6)</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.Repeat = function (obj, count)
|
{
|
/// <summary>Generates a sequence that contains one repeated value.
|
/// If omit count then generate to infinity.
|
/// Ex: Repeat("foo",3) - "foo","foo","foo"</summary>
|
/// <param type="TResult" name="obj">The value to be repeated.</param>
|
/// <param type="Optional:Number" integer="true" name="count" optional="true">The number of times to repeat the value in the generated sequence.</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.RepeatWithFinalize = function (initializer, finalizer)
|
{
|
/// <summary>Lazy Generates one value by initializer's result and do finalize when enumerate end</summary>
|
/// <param type="Func<T>" name="initializer">value factory.</param>
|
/// <param type="Action<T>" name="finalizer">execute when finalize.</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.Generate = function (func, count)
|
{
|
/// <summary>Generates a sequence that execute func value.
|
/// If omit count then generate to infinity.
|
/// Ex: Generate("Math.random()", 5) - 0.131341,0.95425252,...</summary>
|
/// <param type="Func<T>" name="func">The value of execute func to be repeated.</param>
|
/// <param type="Optional:Number" integer="true" name="count" optional="true">The number of times to repeat the value in the generated sequence.</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.ToInfinity = function (start, step)
|
{
|
/// <summary>Generates a sequence of integral numbers to infinity.
|
/// Ex: ToInfinity() - 0,1,2,3...</summary>
|
/// <param type="Optional:Number" integer="true" name="start" optional="true">start integer</param>
|
/// <param type="Optional:Number" integer="true" name="step" optional="true">Step of generate number.(Ex:ToInfinity(10,3) - 10,13,16,19,...)</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.ToNegativeInfinity = function (start, step)
|
{
|
/// <summary>Generates a sequence of integral numbers to negative infinity.
|
/// Ex: ToNegativeInfinity() - 0,-1,-2,-3...</summary>
|
/// <param type="Optional:Number" integer="true" name="start" optional="true">start integer</param>
|
/// <param type="Optional:Number" integer="true" name="step" optional="true">Step of generate number.(Ex:ToNegativeInfinity(10,3) - 10,7,4,1,...)</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.Unfold = function (seed, func)
|
{
|
/// <summary>Applies function and generates a infinity sequence.
|
/// Ex: Unfold(3,"$+10") - 3,13,23,...</summary>
|
/// <param type="T" name="seed">The initial accumulator value.</param>
|
/// <param type="Func<T,T>" name="func">An accumulator function to be invoked on each element.</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
|
Enumerable.prototype =
|
{
|
/* Projection and Filtering Methods */
|
|
CascadeBreadthFirst: function (func, resultSelector)
|
{
|
/// <summary>Projects each element of sequence and flattens the resulting sequences into one sequence use breadth first search.</summary>
|
/// <param name="func" type="Func<T,T[]>">Select child sequence.</param>
|
/// <param name="resultSelector" type="Optional:Func<T>_or_Func<T,int>" optional="true">Optional:the second parameter of the function represents the nestlevel of the source sequence.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
CascadeDepthFirst: function (func, resultSelector)
|
{
|
/// <summary>Projects each element of sequence and flattens the resulting sequences into one sequence use depth first search.</summary>
|
/// <param name="func" type="Func<T,T[]>">Select child sequence.</param>
|
/// <param name="resultSelector" type="Optional:Func<T>_or_Func<T,int>" optional="true">Optional:the second parameter of the function represents the nestlevel of the source sequence.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Flatten: function ()
|
{
|
/// <summary>Flatten sequences into one sequence.</summary>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Pairwise: function (selector)
|
{
|
/// <summary>Projects current and next element of a sequence into a new form.</summary>
|
/// <param type="Func<TSource,TSource,TResult>" name="selector">A transform function to apply to current and next element.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Scan: function (func_or_seed, func, resultSelector)
|
{
|
/// <summary>Applies an accumulator function over a sequence.</summary>
|
/// <param name="func_or_seed" type="Func<T,T,T>_or_TAccumulate">Func is an accumulator function to be invoked on each element. Seed is the initial accumulator value.</param>
|
/// <param name="func" type="Optional:Func<TAccumulate,T,TAccumulate>" optional="true">An accumulator function to be invoked on each element.</param>
|
/// <param name="resultSelector" type="Optional:Func<TAccumulate,TResult>" optional="true">A function to transform the final accumulator value into the result value.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Select: function (selector)
|
{
|
/// <summary>Projects each element of a sequence into a new form.</summary>
|
/// <param name="selector" type="Func<T,T>_or_Func<T,int,T>">A transform function to apply to each source element; Optional:the second parameter of the function represents the index of the source element.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
SelectMany: function (collectionSelector, resultSelector)
|
{
|
/// <summary>Projects each element of a sequence and flattens the resulting sequences into one sequence.</summary>
|
/// <param name="collectionSelector" type="Func<T,TCollection[]>_or_Func<T,int,TCollection[]>">A transform function to apply to each source element; Optional:the second parameter of the function represents the index of the source element.</param>
|
/// <param name="resultSelector" type="Optional:Func<T,TCollection,TResult>" optional="true">Optional:A transform function to apply to each element of the intermediate sequence.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Where: function (predicate)
|
{
|
/// <summary>Filters a sequence of values based on a predicate.</summary>
|
/// <param name="predicate" type="Func<T,bool>_or_Func<T,int,bool>">A function to test each source element for a condition; Optional:the second parameter of the function represents the index of the source element.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
OfType: function (type)
|
{
|
/// <summary>Filters the elements based on a specified type.</summary>
|
/// <param name="type" type="T">The type to filter the elements of the sequence on.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Zip: function (second, selector)
|
{
|
/// <summary>Merges two sequences by using the specified predicate function.</summary>
|
/// <param name="second" type="T[]">The second sequence to merge.</param>
|
/// <param name="selector" type="Func<TFirst,TSecond,TResult>_or_Func<TFirst,TSecond,int,TResult>">A function that specifies how to merge the elements from the two sequences. Optional:the third parameter of the function represents the index of the source element.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
/* Join Methods */
|
|
Join: function (inner, outerKeySelector, innerKeySelector, resultSelector, compareSelector)
|
{
|
/// <summary>Correlates the elements of two sequences based on matching keys.</summary>
|
/// <param name="inner" type="T[]">The sequence to join to the first sequence.</param>
|
/// <param name="outerKeySelector" type="Func<TOuter,TKey>">A function to extract the join key from each element of the first sequence.</param>
|
/// <param name="innerKeySelector" type="Func<TInner,TKey>">A function to extract the join key from each element of the second sequence.</param>
|
/// <param name="resultSelector" type="Func<TOuter,TInner,TResult>">A function to create a result element from two matching elements.</param>
|
/// <param name="compareSelector" type="Optional:Func<TKey,TCompare>" optional="true">An equality comparer to compare values.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
GroupJoin: function (inner, outerKeySelector, innerKeySelector, resultSelector, compareSelector)
|
{
|
/// <summary>Correlates the elements of two sequences based on equality of keys and groups the results.</summary>
|
/// <param name="inner" type="T[]">The sequence to join to the first sequence.</param>
|
/// <param name="outerKeySelector" type="Func<TOuter>">A function to extract the join key from each element of the first sequence.</param>
|
/// <param name="innerKeySelector" type="Func<TInner>">A function to extract the join key from each element of the second sequence.</param>
|
/// <param name="resultSelector" type="Func<TOuter,Enumerable<TInner>,TResult">A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence.</param>
|
/// <param name="compareSelector" type="Optional:Func<TKey,TCompare>" optional="true">An equality comparer to compare values.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
/* Set Methods */
|
|
All: function (predicate)
|
{
|
/// <summary>Determines whether all elements of a sequence satisfy a condition.</summary>
|
/// <param type="Func<T,bool>" name="predicate">A function to test each element for a condition.</param>
|
/// <returns type="Boolean"></returns>
|
},
|
|
Any: function (predicate)
|
{
|
/// <summary>Determines whether a sequence contains any elements or any element of a sequence satisfies a condition.</summary>
|
/// <param name="predicate" type="Optional:Func<T,bool>" optional="true">A function to test each element for a condition.</param>
|
/// <returns type="Boolean"></returns>
|
},
|
|
Concat: function (second)
|
{
|
/// <summary>Concatenates two sequences.</summary>
|
/// <param name="second" type="T[]">The sequence to concatenate to the first sequence.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Insert: function (index, second)
|
{
|
/// <summary>Merge two sequences.</summary>
|
/// <param name="index" type="Number" integer="true">The index of insert start position.</param>
|
/// <param name="second" type="T[]">The sequence to concatenate to the first sequence.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Alternate: function (value)
|
{
|
/// <summary>Insert value to between sequence.</summary>
|
/// <param name="value" type="T">The value of insert.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
// Overload:function(value)
|
// Overload:function(value, compareSelector)
|
Contains: function (value, compareSelector)
|
{
|
/// <summary>Determines whether a sequence contains a specified element.</summary>
|
/// <param name="value" type="T">The value to locate in the sequence.</param>
|
/// <param name="compareSelector" type="Optional:Func<T,TKey>" optional="true">An equality comparer to compare values.</param>
|
/// <returns type="Boolean"></returns>
|
},
|
|
DefaultIfEmpty: function (defaultValue)
|
{
|
/// <summary>Returns the elements of the specified sequence or the specified value in a singleton collection if the sequence is empty.</summary>
|
/// <param name="defaultValue" type="T">The value to return if the sequence is empty.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Distinct: function (compareSelector)
|
{
|
/// <summary>Returns distinct elements from a sequence.</summary>
|
/// <param name="compareSelector" type="Optional:Func<T,TKey>" optional="true">An equality comparer to compare values.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Except: function (second, compareSelector)
|
{
|
/// <summary>Produces the set difference of two sequences.</summary>
|
/// <param name="second" type="T[]">An T[] whose Elements that also occur in the first sequence will cause those elements to be removed from the returned sequence.</param>
|
/// <param name="compareSelector" type="Optional:Func<T,TKey>" optional="true">An equality comparer to compare values.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Intersect: function (second, compareSelector)
|
{
|
/// <summary>Produces the set difference of two sequences.</summary>
|
/// <param name="second" type="T[]">An T[] whose distinct elements that also appear in the first sequence will be returned.</param>
|
/// <param name="compareSelector" type="Optional:Func<T,TKey>" optional="true">An equality comparer to compare values.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
SequenceEqual: function (second, compareSelector)
|
{
|
/// <summary>Determines whether two sequences are equal by comparing the elements.</summary>
|
/// <param name="second" type="T[]">An T[] to compare to the first sequence.</param>
|
/// <param name="compareSelector" type="Optional:Func<T,TKey>" optional="true">An equality comparer to compare values.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Union: function (second, compareSelector)
|
{
|
/// <summary>Produces the union of two sequences.</summary>
|
/// <param name="second" type="T[]">An T[] whose distinct elements form the second set for the union.</param>
|
/// <param name="compareSelector" type="Optional:Func<T,TKey>" optional="true">An equality comparer to compare values.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
/* Ordering Methods */
|
|
OrderBy: function (keySelector)
|
{
|
/// <summary>Sorts the elements of a sequence in ascending order according to a key.</summary>
|
/// <param name="keySelector" type="Optional:Func<T,TKey>">A function to extract a key from an element.</param>
|
return new OrderedEnumerable();
|
},
|
|
OrderByDescending: function (keySelector)
|
{
|
/// <summary>Sorts the elements of a sequence in descending order according to a key.</summary>
|
/// <param name="keySelector" type="Optional:Func<T,TKey>">A function to extract a key from an element.</param>
|
return new OrderedEnumerable();
|
},
|
|
Reverse: function ()
|
{
|
/// <summary>Inverts the order of the elements in a sequence.</summary>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Shuffle: function ()
|
{
|
/// <summary>Shuffle sequence.</summary>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
/* Grouping Methods */
|
|
GroupBy: function (keySelector, elementSelector, resultSelector, compareSelector)
|
{
|
/// <summary>Groups the elements of a sequence according to a specified key selector function.</summary>
|
/// <param name="keySelector" type="Func<T,TKey>">A function to extract the key for each element.</param>
|
/// <param name="elementSelector" type="Optional:Func<T,TElement>">A function to map each source element to an element in an Grouping<TKey, TElement>.</param>
|
/// <param name="resultSelector" type="Optional:Func<TKey,Enumerable<TElement>,TResult>">A function to create a result value from each group.</param>
|
/// <param name="compareSelector" type="Optional:Func<TKey,TCompare>" optional="true">An equality comparer to compare values.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
PartitionBy: function (keySelector, elementSelector, resultSelector, compareSelector)
|
{
|
/// <summary>Create Group by continuation key.</summary>
|
/// <param name="keySelector" type="Func<T,TKey>">A function to extract the key for each element.</param>
|
/// <param name="elementSelector" type="Optional:Func<T,TElement>">A function to map each source element to an element in an Grouping<TKey, TElement>.</param>
|
/// <param name="resultSelector" type="Optional:Func<TKey,Enumerable<TElement>,TResult>">A function to create a result value from each group.</param>
|
/// <param name="compareSelector" type="Optional:Func<TKey,TCompare>" optional="true">An equality comparer to compare values.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
BufferWithCount: function (count)
|
{
|
/// <summary>Divide by count</summary>
|
/// <param name="count" type="Number" integer="true">integer</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
|
/* Aggregate Methods */
|
|
Aggregate: function (func_or_seed, func, resultSelector)
|
{
|
/// <summary>Applies an accumulator function over a sequence.</summary>
|
/// <param name="func_or_seed" type="Func<T,T,T>_or_TAccumulate">Func is an accumulator function to be invoked on each element. Seed is the initial accumulator value.</param>
|
/// <param name="func" type="Optional:Func<TAccumulate,T,TAccumulate>" optional="true">An accumulator function to be invoked on each element.</param>
|
/// <param name="resultSelector" type="Optional:Func<TAccumulate,TResult>" optional="true">A function to transform the final accumulator value into the result value.</param>
|
/// <returns type="TResult"></returns>
|
},
|
|
Average: function (selector)
|
{
|
/// <summary>Computes the average of a sequence.</summary>
|
/// <param name="selector" type="Optional:Func<T,Number>" optional="true">A transform function to apply to each element.</param>
|
/// <returns type="Number"></returns>
|
},
|
|
Count: function (predicate)
|
{
|
/// <summary>Returns the number of elements in a sequence.</summary>
|
/// <param name="predicate" type="Optional:Func<T,Boolean>" optional="true">A function to test each element for a condition.</param>
|
/// <returns type="Number"></returns>
|
},
|
|
Max: function (selector)
|
{
|
/// <summary>Returns the maximum value in a sequence</summary>
|
/// <param name="selector" type="Optional:Func<T,TKey>" optional="true">A transform function to apply to each element.</param>
|
/// <returns type="Number"></returns>
|
},
|
|
Min: function (selector)
|
{
|
/// <summary>Returns the minimum value in a sequence</summary>
|
/// <param name="selector" type="Optional:Func<T,TKey>" optional="true">A transform function to apply to each element.</param>
|
/// <returns type="Number"></returns>
|
},
|
|
MaxBy: function (keySelector)
|
{
|
/// <summary>Returns the maximum value in a sequence by keySelector</summary>
|
/// <param name="keySelector" type="Func<T,TKey>">A compare selector of element.</param>
|
/// <returns type="T"></returns>
|
},
|
|
MinBy: function (keySelector)
|
{
|
/// <summary>Returns the minimum value in a sequence by keySelector</summary>
|
/// <param name="keySelector" type="Func<T,TKey>">A compare selector of element.</param>
|
/// <returns type="T"></returns>
|
},
|
|
Sum: function (selector)
|
{
|
/// <summary>Computes the sum of a sequence of values.</summary>
|
/// <param name="selector" type="Optional:Func<T,TKey>" optional="true">A transform function to apply to each element.</param>
|
/// <returns type="Number"></returns>
|
},
|
|
/* Paging Methods */
|
|
ElementAt: function (index)
|
{
|
/// <summary>Returns the element at a specified index in a sequence.</summary>
|
/// <param name="index" type="Number" integer="true">The zero-based index of the element to retrieve.</param>
|
/// <returns type="T"></returns>
|
},
|
|
ElementAtOrDefault: function (index, defaultValue)
|
{
|
/// <summary>Returns the element at a specified index in a sequence or a default value if the index is out of range.</summary>
|
/// <param name="index" type="Number" integer="true">The zero-based index of the element to retrieve.</param>
|
/// <param name="defaultValue" type="T">The value if the index is outside the bounds then send.</param>
|
/// <returns type="T"></returns>
|
},
|
|
First: function (predicate)
|
{
|
/// <summary>Returns the first element of a sequence.</summary>
|
/// <param name="predicate" type="Optional:Func<T,Boolean>">A function to test each element for a condition.</param>
|
/// <returns type="T"></returns>
|
},
|
|
FirstOrDefault: function (defaultValue, predicate)
|
{
|
/// <summary>Returns the first element of a sequence, or a default value.</summary>
|
/// <param name="defaultValue" type="T">The value if not found then send.</param>
|
/// <param name="predicate" type="Optional:Func<T,Boolean>">A function to test each element for a condition.</param>
|
/// <returns type="T"></returns>
|
},
|
|
Last: function (predicate)
|
{
|
/// <summary>Returns the last element of a sequence.</summary>
|
/// <param name="predicate" type="Optional:Func<T,Boolean>">A function to test each element for a condition.</param>
|
/// <returns type="T"></returns>
|
},
|
|
LastOrDefault: function (defaultValue, predicate)
|
{
|
/// <summary>Returns the last element of a sequence, or a default value.</summary>
|
/// <param name="defaultValue" type="T">The value if not found then send.</param>
|
/// <param name="predicate" type="Optional:Func<T,Boolean>">A function to test each element for a condition.</param>
|
/// <returns type="T"></returns>
|
},
|
|
Single: function (predicate)
|
{
|
/// <summary>Returns the only element of a sequence that satisfies a specified condition, and throws an exception if more than one such element exists.</summary>
|
/// <param name="predicate" type="Optional:Func<T,Boolean>">A function to test each element for a condition.</param>
|
/// <returns type="T"></returns>
|
},
|
|
SingleOrDefault: function (defaultValue, predicate)
|
{
|
/// <summary>Returns a single, specific element of a sequence of values, or a default value if no such element is found.</summary>
|
/// <param name="defaultValue" type="T">The value if not found then send.</param>
|
/// <param name="predicate" type="Optional:Func<T,Boolean>">A function to test each element for a condition.</param>
|
/// <returns type="T"></returns>
|
},
|
|
Skip: function (count)
|
{
|
/// <summary>Bypasses a specified number of elements in a sequence and then returns the remaining elements.</summary>
|
/// <param name="count" type="Number" integer="true">The number of elements to skip before returning the remaining elements.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
SkipWhile: function (predicate)
|
{
|
/// <summary>Bypasses elements in a sequence as long as a specified condition is true and then returns the remaining elements.</summary>
|
/// <param name="predicate" type="Func<T,Boolean>_or_Func<T,int,Boolean>">A function to test each source element for a condition; Optional:the second parameter of the function represents the index of the source element.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Take: function (count)
|
{
|
/// <summary>Returns a specified number of contiguous elements from the start of a sequence.</summary>
|
/// <param name="count" type="Number" integer="true">The number of elements to return.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
TakeWhile: function (predicate)
|
{
|
/// <summary>Returns elements from a sequence as long as a specified condition is true, and then skips the remaining elements.</summary>
|
/// <param name="predicate" type="Func<T,Boolean>_or_Func<T,int,Boolean>">A function to test each source element for a condition; Optional:the second parameter of the function represents the index of the source element.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
TakeExceptLast: function (count)
|
{
|
/// <summary>Take a sequence except last count.</summary>
|
/// <param name="count" type="Optional:Number" integer="true">The number of skip count.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
TakeFromLast: function (count)
|
{
|
/// <summary>Take a sequence from last count.</summary>
|
/// <param name="count" type="Number" integer="true">The number of take count.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
IndexOf: function (item)
|
{
|
/// <summary>Returns the zero-based index of the flrst occurrence of a value.</summary>
|
/// <param name="item" type="T">The zero-based starting index of the search.</param>
|
/// <returns type="Number" integer="true"></returns>
|
},
|
|
LastIndexOf: function (item)
|
{
|
/// <summary>Returns the zero-based index of the last occurrence of a value.</summary>
|
/// <param name="item" type="T">The zero-based starting index of the search.</param>
|
/// <returns type="Number" integer="true"></returns>
|
},
|
|
/* Convert Methods */
|
|
ToArray: function ()
|
{
|
/// <summary>Creates an array from this sequence.</summary>
|
/// <returns type="Array"></returns>
|
},
|
|
ToLookup: function (keySelector, elementSelector, compareSelector)
|
{
|
/// <summary>Creates a Lookup from this sequence.</summary>
|
/// <param name="keySelector" type="Func<T,TKey>">A function to extract a key from each element.</param>
|
/// <param name="elementSelector" type="Optional:Func<T,TElement>">A transform function to produce a result element value from each element.</param>
|
/// <param name="compareSelector" type="Optional:Func<TKey,TCompare>" optional="true">An equality comparer to compare values.</param>
|
return new Lookup();
|
},
|
|
ToObject: function (keySelector, elementSelector)
|
{
|
/// <summary>Creates a Object from this sequence.</summary>
|
/// <param name="keySelector" type="Func<T,String>">A function to extract a key from each element.</param>
|
/// <param name="elementSelector" type="Func<T,TElement>">A transform function to produce a result element value from each element.</param>
|
/// <returns type="Object"></returns>
|
},
|
|
ToDictionary: function (keySelector, elementSelector, compareSelector)
|
{
|
/// <summary>Creates a Dictionary from this sequence.</summary>
|
/// <param name="keySelector" type="Func<T,TKey>">A function to extract a key from each element.</param>
|
/// <param name="elementSelector" type="Func<T,TElement>">A transform function to produce a result element value from each element.</param>
|
/// <param name="compareSelector" type="Optional:Func<TKey,TCompare>" optional="true">An equality comparer to compare values.</param>
|
return new Dictionary();
|
},
|
|
// Overload:function()
|
// Overload:function(replacer)
|
// Overload:function(replacer, space)
|
ToJSON: function (replacer, space)
|
{
|
/// <summary>Creates a JSON String from sequence, performed only native JSON support browser or included json2.js.</summary>
|
/// <param name="replacer" type="Optional:Func">a replacer.</param>
|
/// <param name="space" type="Optional:Number">indent spaces.</param>
|
/// <returns type="String"></returns>
|
},
|
|
// Overload:function()
|
// Overload:function(separator)
|
// Overload:function(separator,selector)
|
ToString: function (separator, selector)
|
{
|
/// <summary>Creates Joined string from this sequence.</summary>
|
/// <param name="separator" type="Optional:String">A String.</param>
|
/// <param name="selector" type="Optional:Func<T,String>">A transform function to apply to each source element.</param>
|
/// <returns type="String"></returns>
|
},
|
|
/* Action Methods */
|
|
Do: function (action)
|
{
|
/// <summary>Performs the specified action on each element of the sequence.</summary>
|
/// <param name="action" type="Action<T>_or_Action<T,int>">Optional:the second parameter of the function represents the index of the source element.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
ForEach: function (action)
|
{
|
/// <summary>Performs the specified action on each element of the sequence.</summary>
|
/// <param name="action" type="Action<T>_or_Action<T,int>">[return true;]continue iteration.[return false;]break iteration. Optional:the second parameter of the function represents the index of the source element.</param>
|
/// <returns type="void"></returns>
|
},
|
|
Write: function (separator, selector)
|
{
|
/// <summary>Do document.write.</summary>
|
/// <param name="separator" type="Optional:String">A String.</param>
|
/// <param name="selector" type="Optional:Func<T,String>">A transform function to apply to each source element.</param>
|
/// <returns type="void"></returns>
|
},
|
|
WriteLine: function (selector)
|
{
|
/// <summary>Do document.write + <br />.</summary>
|
/// <param name="selector" type="Optional:Func<T,String>">A transform function to apply to each source element.</param>
|
/// <returns type="void"></returns>
|
},
|
|
Force: function ()
|
{
|
/// <summary>Execute enumerate.</summary>
|
/// <returns type="void"></returns>
|
},
|
|
/* Functional Methods */
|
|
Let: function (func)
|
{
|
/// <summary>Bind the source to the parameter so that it can be used multiple times.</summary>
|
/// <param name="func" type="Func<Enumerable<T>,Enumerable<TR>>">apply function.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Share: function ()
|
{
|
/// <summary>Shares cursor of all enumerators to the sequence.</summary>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
MemoizeAll: function ()
|
{
|
/// <summary>Creates an enumerable that enumerates the original enumerable only once and caches its results.</summary>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
|
/* Error Handling Methods */
|
|
Catch: function (handler)
|
{
|
/// <summary>catch error and do handler.</summary>
|
/// <param name="handler" type="Action<Error>">execute if error occured.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Finally: function (finallyAction)
|
{
|
/// <summary>do action if enumerate end or disposed or error occured.</summary>
|
/// <param name="handler" type="Action">finally execute.</param>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
/* For Debug Methods */
|
|
Trace: function (message, selector)
|
{
|
/// <summary>Trace object use console.log.</summary>
|
/// <param name="message" type="Optional:String">Default is 'Trace:'.</param>
|
/// <param name="selector" type="Optional:Func<T,String>">A transform function to apply to each source element.</param>
|
/// <returns type="Enumerable"></returns>
|
}
|
}
|
|
// vsdoc-dummy
|
|
Enumerable.prototype.GetEnumerator = function ()
|
{
|
/// <summary>Returns an enumerator that iterates through the collection.</summary>
|
return new IEnumerator();
|
}
|
|
var IEnumerator = function () { }
|
IEnumerator.prototype.Current = function ()
|
{
|
/// <summary>Gets the element in the collection at the current position of the enumerator.</summary>
|
/// <returns type="T"></returns>
|
}
|
IEnumerator.prototype.MoveNext = function ()
|
{
|
/// <summary>Advances the enumerator to the next element of the collection.</summary>
|
/// <returns type="Boolean"></returns>
|
}
|
IEnumerator.prototype.Dispose = function ()
|
{
|
/// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
|
/// <returns type="Void"></returns>
|
}
|
|
var Dictionary = function () { }
|
Dictionary.prototype =
|
{
|
Add: function (key, value)
|
{
|
/// <summary>add new pair. if duplicate key then overwrite new value.</summary>
|
/// <returns type="Void"></returns>
|
},
|
|
Get: function (key)
|
{
|
/// <summary>get value. if not find key then return undefined.</summary>
|
/// <returns type="T"></returns>
|
},
|
|
Set: function (key, value)
|
{
|
/// <summary>set value. if complete set value then return true, not find key then return false.</summary>
|
/// <returns type="Boolean"></returns>
|
},
|
|
Contains: function (key)
|
{
|
/// <summary>check contains key.</summary>
|
/// <returns type="Boolean"></returns>
|
},
|
|
Clear: function ()
|
{
|
/// <summary>clear dictionary.</summary>
|
/// <returns type="Void"></returns>
|
},
|
|
Remove: function (key)
|
{
|
/// <summary>remove key and value.</summary>
|
/// <returns type="Void"></returns>
|
},
|
|
Count: function ()
|
{
|
/// <summary>contains value's count.</summary>
|
/// <returns type="Number"></returns>
|
},
|
|
ToEnumerable: function ()
|
{
|
/// <summary>Convert to Enumerable<{Key:, Value:}>.</summary>
|
/// <returns type="Enumerable"></returns>
|
}
|
}
|
|
var Lookup = function () { }
|
Lookup.prototype =
|
{
|
Count: function ()
|
{
|
/// <summary>contains value's count.</summary>
|
/// <returns type="Number"></returns>
|
},
|
|
Get: function (key)
|
{
|
/// <summary>get grouped enumerable.</summary>
|
/// <returns type="Enumerable"></returns>
|
},
|
|
Contains: function (key)
|
{
|
/// <summary>check contains key.</summary>
|
/// <returns type="Boolean"></returns>
|
},
|
|
ToEnumerable: function ()
|
{
|
/// <summary>Convert to Enumerable<Grouping>.</summary>
|
/// <returns type="Enumerable"></returns>
|
}
|
}
|
|
|
var Grouping = function () { }
|
Grouping.prototype = new Enumerable();
|
Grouping.prototype.Key = function ()
|
{
|
/// <summary>get grouping key.</summary>
|
/// <returns type="T"></returns>
|
}
|
|
var OrderedEnumerable = function () { }
|
OrderedEnumerable.prototype = new Enumerable();
|
|
OrderedEnumerable.prototype.ThenBy = function (keySelector)
|
{
|
/// <summary>Performs a subsequent ordering of the elements in a sequence in ascending order according to a key.</summary>
|
/// <param name="keySelector" type="Func<T,TKey>">A function to extract a key from each element.</param>
|
return Enumerable.Empty().OrderBy();
|
}
|
|
OrderedEnumerable.prototype.ThenByDescending = function (keySelector)
|
{
|
/// <summary>Performs a subsequent ordering of the elements in a sequence in descending order, according to a key.</summary>
|
/// <param name="keySelector" type="Func<T,TKey>">A function to extract a key from each element.</param>
|
return Enumerable.Empty().OrderBy();
|
}
|
|
return Enumerable;
|
})()
|
