Skip to content

Commit 4741255

Browse files
mkloubertmkloubert
committed
fixed documentation
1 parent 1147995 commit 4741255

4 files changed

Lines changed: 30 additions & 30 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Change Log (node-enumerable)
22

3-
## 3.5.0 (November 5th, 2017; methods)
3+
## 3.5.1 (November 5th, 2017; methods)
44

55
* added `cos()` and `arcCos()` methods
66
* added `cosH()` and `arcCosH()` methods

‎index.d.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ declare namespace Enumerable {
261261
*/
262262
any(predicate?: Predicate<T>): boolean;
263263
/**
264-
* Handles current items as base numbers and calculates the arc cosine for each item.
264+
* Handles current items as numbers and calculates the arc cosine for each item.
265265
*
266266
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
267267
* Default: (false)
@@ -270,7 +270,7 @@ declare namespace Enumerable {
270270
*/
271271
arcCos(handleAsInt?: boolean): IEnumerable<number>;
272272
/**
273-
* Handles current items as base numbers and calculates the arc hyperbolic cosine for each item.
273+
* Handles current items as numbers and calculates the arc hyperbolic cosine for each item.
274274
*
275275
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
276276
* Default: (false)
@@ -279,7 +279,7 @@ declare namespace Enumerable {
279279
*/
280280
arcCosH(handleAsInt?: boolean): IEnumerable<number>;
281281
/**
282-
* Handles current items as base numbers and calculates the arc sine for each item.
282+
* Handles current items as numbers and calculates the arc sine for each item.
283283
*
284284
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
285285
* Default: (false)
@@ -288,7 +288,7 @@ declare namespace Enumerable {
288288
*/
289289
arcSin(handleAsInt?: boolean): IEnumerable<number>;
290290
/**
291-
* Handles current items as base numbers and calculates the arc hyperbolic sine for each item.
291+
* Handles current items as numbers and calculates the arc hyperbolic sine for each item.
292292
*
293293
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
294294
* Default: (false)
@@ -297,7 +297,7 @@ declare namespace Enumerable {
297297
*/
298298
arcSinH(handleAsInt?: boolean): IEnumerable<number>;
299299
/**
300-
* Handles current items as base numbers and calculates the arc tangent for each item.
300+
* Handles current items as numbers and calculates the arc tangent for each item.
301301
*
302302
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
303303
* Default: (false)
@@ -306,7 +306,7 @@ declare namespace Enumerable {
306306
*/
307307
arcTan(handleAsInt?: boolean): IEnumerable<number>;
308308
/**
309-
* Handles current items as base numbers and calculates the arc hyperbolic tangent for each item.
309+
* Handles current items as numbers and calculates the arc hyperbolic tangent for each item.
310310
*
311311
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
312312
* Default: (false)
@@ -407,7 +407,7 @@ declare namespace Enumerable {
407407
*/
408408
contains<U>(item: U, comparer?: EqualityComparer<T, U> | true): boolean;
409409
/**
410-
* Handles current items as base numbers and calculates the cosine for each item.
410+
* Handles current items as numbers and calculates the cosine for each item.
411411
*
412412
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
413413
* Default: (false)
@@ -416,7 +416,7 @@ declare namespace Enumerable {
416416
*/
417417
cos(handleAsInt?: boolean): IEnumerable<number>;
418418
/**
419-
* Handles current items as base numbers and calculates the hyperbolic cosine for each item.
419+
* Handles current items as numbers and calculates the hyperbolic cosine for each item.
420420
*
421421
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
422422
* Default: (false)
@@ -674,7 +674,7 @@ declare namespace Enumerable {
674674
*/
675675
lastOrDefault<U = symbol>(predicateOrDefaultValue?: Predicate<T> | T, defaultValue?: U): T | U;
676676
/**
677-
* Handles current items as base numbers and calculates the natural logarithm (base e) of a them.
677+
* Handles current items as numbers and calculates the natural logarithm (base e) of a them.
678678
*
679679
* @param {number} [base] The custom base. Default: e
680680
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
@@ -861,7 +861,7 @@ declare namespace Enumerable {
861861
*/
862862
shuffle(sortValueProvider?: () => any): IOrderedEnumerable<T>;
863863
/**
864-
* Handles current items as base numbers and calculates the sine for each item.
864+
* Handles current items as numbers and calculates the sine for each item.
865865
*
866866
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
867867
* Default: (false)
@@ -894,7 +894,7 @@ declare namespace Enumerable {
894894
*/
895895
singleOrDefault<U = symbol>(predicateOrDefaultValue?: Predicate<T> | T, defaultValue?: U): T | U;
896896
/**
897-
* Handles current items as base numbers and calculates the hyperbolic sine for each item.
897+
* Handles current items as numbers and calculates the hyperbolic sine for each item.
898898
*
899899
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
900900
* Default: (false)
@@ -925,7 +925,7 @@ declare namespace Enumerable {
925925
*/
926926
skipWhile(predicate: Predicate<T>): IEnumerable<T>;
927927
/**
928-
* Handles current items as base numbers and calculates square root for each item.
928+
* Handles current items as numbers and calculates square root for each item.
929929
*
930930
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
931931
* Default: (false)
@@ -956,7 +956,7 @@ declare namespace Enumerable {
956956
*/
957957
takeWhile(predicate: Predicate<T>): IEnumerable<T>;
958958
/**
959-
* Handles current items as base numbers and calculates the tangent for each item.
959+
* Handles current items as numbers and calculates the tangent for each item.
960960
*
961961
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
962962
* Default: (false)
@@ -965,7 +965,7 @@ declare namespace Enumerable {
965965
*/
966966
tan(handleAsInt?: boolean): IEnumerable<number>;
967967
/**
968-
* Handles current items as base numbers and calculates the hyperbolic tangent for each item.
968+
* Handles current items as numbers and calculates the hyperbolic tangent for each item.
969969
*
970970
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
971971
* Default: (false)

‎index.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ namespace Enumerable {
301301
*/
302302
any(predicate?: Predicate<T>): boolean;
303303
/**
304-
* Handles current items as base numbers and calculates the arc cosine for each item.
304+
* Handles current items as numbers and calculates the arc cosine for each item.
305305
*
306306
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
307307
* Default: (false)
@@ -310,7 +310,7 @@ namespace Enumerable {
310310
*/
311311
arcCos(handleAsInt?: boolean): IEnumerable<number>;
312312
/**
313-
* Handles current items as base numbers and calculates the arc hyperbolic cosine for each item.
313+
* Handles current items as numbers and calculates the arc hyperbolic cosine for each item.
314314
*
315315
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
316316
* Default: (false)
@@ -319,7 +319,7 @@ namespace Enumerable {
319319
*/
320320
arcCosH(handleAsInt?: boolean): IEnumerable<number>;
321321
/**
322-
* Handles current items as base numbers and calculates the arc sine for each item.
322+
* Handles current items as numbers and calculates the arc sine for each item.
323323
*
324324
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
325325
* Default: (false)
@@ -328,7 +328,7 @@ namespace Enumerable {
328328
*/
329329
arcSin(handleAsInt?: boolean): IEnumerable<number>;
330330
/**
331-
* Handles current items as base numbers and calculates the arc hyperbolic sine for each item.
331+
* Handles current items as numbers and calculates the arc hyperbolic sine for each item.
332332
*
333333
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
334334
* Default: (false)
@@ -337,7 +337,7 @@ namespace Enumerable {
337337
*/
338338
arcSinH(handleAsInt?: boolean): IEnumerable<number>;
339339
/**
340-
* Handles current items as base numbers and calculates the arc tangent for each item.
340+
* Handles current items as numbers and calculates the arc tangent for each item.
341341
*
342342
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
343343
* Default: (false)
@@ -346,7 +346,7 @@ namespace Enumerable {
346346
*/
347347
arcTan(handleAsInt?: boolean): IEnumerable<number>;
348348
/**
349-
* Handles current items as base numbers and calculates the arc hyperbolic tangent for each item.
349+
* Handles current items as numbers and calculates the arc hyperbolic tangent for each item.
350350
*
351351
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
352352
* Default: (false)
@@ -450,7 +450,7 @@ namespace Enumerable {
450450
contains<U>(item: U,
451451
comparer?: EqualityComparer<T, U> | true): boolean;
452452
/**
453-
* Handles current items as base numbers and calculates the cosine for each item.
453+
* Handles current items as numbers and calculates the cosine for each item.
454454
*
455455
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
456456
* Default: (false)
@@ -459,7 +459,7 @@ namespace Enumerable {
459459
*/
460460
cos(handleAsInt?: boolean): IEnumerable<number>;
461461
/**
462-
* Handles current items as base numbers and calculates the hyperbolic cosine for each item.
462+
* Handles current items as numbers and calculates the hyperbolic cosine for each item.
463463
*
464464
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
465465
* Default: (false)
@@ -738,7 +738,7 @@ namespace Enumerable {
738738
lastOrDefault<U = symbol>(predicateOrDefaultValue?: Predicate<T> | T,
739739
defaultValue?: U): T | U;
740740
/**
741-
* Handles current items as base numbers and calculates the natural logarithm (base e) of a them.
741+
* Handles current items as numbers and calculates the natural logarithm (base e) of a them.
742742
*
743743
* @param {number} [base] The custom base. Default: e
744744
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
@@ -930,7 +930,7 @@ namespace Enumerable {
930930
*/
931931
shuffle(sortValueProvider?: () => any): IOrderedEnumerable<T>;
932932
/**
933-
* Handles current items as base numbers and calculates the sine for each item.
933+
* Handles current items as numbers and calculates the sine for each item.
934934
*
935935
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
936936
* Default: (false)
@@ -964,7 +964,7 @@ namespace Enumerable {
964964
singleOrDefault<U=symbol>(predicateOrDefaultValue?: Predicate<T> | T,
965965
defaultValue?: U): T | U;
966966
/**
967-
* Handles current items as base numbers and calculates the hyperbolic sine for each item.
967+
* Handles current items as numbers and calculates the hyperbolic sine for each item.
968968
*
969969
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
970970
* Default: (false)
@@ -995,7 +995,7 @@ namespace Enumerable {
995995
*/
996996
skipWhile(predicate: Predicate<T>): IEnumerable<T>;
997997
/**
998-
* Handles current items as base numbers and calculates square root for each item.
998+
* Handles current items as numbers and calculates square root for each item.
999999
*
10001000
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
10011001
* Default: (false)
@@ -1026,7 +1026,7 @@ namespace Enumerable {
10261026
*/
10271027
takeWhile(predicate: Predicate<T>): IEnumerable<T>;
10281028
/**
1029-
* Handles current items as base numbers and calculates the tangent for each item.
1029+
* Handles current items as numbers and calculates the tangent for each item.
10301030
*
10311031
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
10321032
* Default: (false)
@@ -1035,7 +1035,7 @@ namespace Enumerable {
10351035
*/
10361036
tan(handleAsInt?: boolean): IEnumerable<number>;
10371037
/**
1038-
* Handles current items as base numbers and calculates the hyperbolic tangent for each item.
1038+
* Handles current items as numbers and calculates the hyperbolic tangent for each item.
10391039
*
10401040
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
10411041
* Default: (false)

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "node-enumerable",
3-
"version": "3.5.0",
3+
"version": "3.5.1",
44
"description": "ES6 ready LINQ features written in TypeScript",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)