Skip to content

Commit

Permalink
fixed documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@mkloubert
mkloubert committed Nov 5, 2017
1 parent 1147995 commit 4741255
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 30 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Change Log (node-enumerable)

## 3.5.0 (November 5th, 2017; methods)
## 3.5.1 (November 5th, 2017; methods)

* added `cos()` and `arcCos()` methods
* added `cosH()` and `arcCosH()` methods
Expand Down
28 changes: 14 additions & 14 deletions index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ declare namespace Enumerable {
*/
any(predicate?: Predicate<T>): boolean;
/**
* Handles current items as base numbers and calculates the arc cosine for each item.
* Handles current items as numbers and calculates the arc cosine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -270,7 +270,7 @@ declare namespace Enumerable {
*/
arcCos(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the arc hyperbolic cosine for each item.
* Handles current items as numbers and calculates the arc hyperbolic cosine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -279,7 +279,7 @@ declare namespace Enumerable {
*/
arcCosH(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the arc sine for each item.
* Handles current items as numbers and calculates the arc sine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -288,7 +288,7 @@ declare namespace Enumerable {
*/
arcSin(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the arc hyperbolic sine for each item.
* Handles current items as numbers and calculates the arc hyperbolic sine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -297,7 +297,7 @@ declare namespace Enumerable {
*/
arcSinH(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the arc tangent for each item.
* Handles current items as numbers and calculates the arc tangent for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -306,7 +306,7 @@ declare namespace Enumerable {
*/
arcTan(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the arc hyperbolic tangent for each item.
* Handles current items as numbers and calculates the arc hyperbolic tangent for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down Expand Up @@ -407,7 +407,7 @@ declare namespace Enumerable {
*/
contains<U>(item: U, comparer?: EqualityComparer<T, U> | true): boolean;
/**
* Handles current items as base numbers and calculates the cosine for each item.
* Handles current items as numbers and calculates the cosine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -416,7 +416,7 @@ declare namespace Enumerable {
*/
cos(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the hyperbolic cosine for each item.
* Handles current items as numbers and calculates the hyperbolic cosine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down Expand Up @@ -674,7 +674,7 @@ declare namespace Enumerable {
*/
lastOrDefault<U = symbol>(predicateOrDefaultValue?: Predicate<T> | T, defaultValue?: U): T | U;
/**
* Handles current items as base numbers and calculates the natural logarithm (base e) of a them.
* Handles current items as numbers and calculates the natural logarithm (base e) of a them.
*
* @param {number} [base] The custom base. Default: e
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
Expand Down Expand Up @@ -861,7 +861,7 @@ declare namespace Enumerable {
*/
shuffle(sortValueProvider?: () => any): IOrderedEnumerable<T>;
/**
* Handles current items as base numbers and calculates the sine for each item.
* Handles current items as numbers and calculates the sine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down Expand Up @@ -894,7 +894,7 @@ declare namespace Enumerable {
*/
singleOrDefault<U = symbol>(predicateOrDefaultValue?: Predicate<T> | T, defaultValue?: U): T | U;
/**
* Handles current items as base numbers and calculates the hyperbolic sine for each item.
* Handles current items as numbers and calculates the hyperbolic sine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down Expand Up @@ -925,7 +925,7 @@ declare namespace Enumerable {
*/
skipWhile(predicate: Predicate<T>): IEnumerable<T>;
/**
* Handles current items as base numbers and calculates square root for each item.
* Handles current items as numbers and calculates square root for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down Expand Up @@ -956,7 +956,7 @@ declare namespace Enumerable {
*/
takeWhile(predicate: Predicate<T>): IEnumerable<T>;
/**
* Handles current items as base numbers and calculates the tangent for each item.
* Handles current items as numbers and calculates the tangent for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -965,7 +965,7 @@ declare namespace Enumerable {
*/
tan(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the hyperbolic tangent for each item.
* Handles current items as numbers and calculates the hyperbolic tangent for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down
28 changes: 14 additions & 14 deletions index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ namespace Enumerable {
*/
any(predicate?: Predicate<T>): boolean;
/**
* Handles current items as base numbers and calculates the arc cosine for each item.
* Handles current items as numbers and calculates the arc cosine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -310,7 +310,7 @@ namespace Enumerable {
*/
arcCos(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the arc hyperbolic cosine for each item.
* Handles current items as numbers and calculates the arc hyperbolic cosine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -319,7 +319,7 @@ namespace Enumerable {
*/
arcCosH(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the arc sine for each item.
* Handles current items as numbers and calculates the arc sine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -328,7 +328,7 @@ namespace Enumerable {
*/
arcSin(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the arc hyperbolic sine for each item.
* Handles current items as numbers and calculates the arc hyperbolic sine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -337,7 +337,7 @@ namespace Enumerable {
*/
arcSinH(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the arc tangent for each item.
* Handles current items as numbers and calculates the arc tangent for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -346,7 +346,7 @@ namespace Enumerable {
*/
arcTan(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the arc hyperbolic tangent for each item.
* Handles current items as numbers and calculates the arc hyperbolic tangent for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down Expand Up @@ -450,7 +450,7 @@ namespace Enumerable {
contains<U>(item: U,
comparer?: EqualityComparer<T, U> | true): boolean;
/**
* Handles current items as base numbers and calculates the cosine for each item.
* Handles current items as numbers and calculates the cosine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -459,7 +459,7 @@ namespace Enumerable {
*/
cos(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the hyperbolic cosine for each item.
* Handles current items as numbers and calculates the hyperbolic cosine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down Expand Up @@ -738,7 +738,7 @@ namespace Enumerable {
lastOrDefault<U = symbol>(predicateOrDefaultValue?: Predicate<T> | T,
defaultValue?: U): T | U;
/**
* Handles current items as base numbers and calculates the natural logarithm (base e) of a them.
* Handles current items as numbers and calculates the natural logarithm (base e) of a them.
*
* @param {number} [base] The custom base. Default: e
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
Expand Down Expand Up @@ -930,7 +930,7 @@ namespace Enumerable {
*/
shuffle(sortValueProvider?: () => any): IOrderedEnumerable<T>;
/**
* Handles current items as base numbers and calculates the sine for each item.
* Handles current items as numbers and calculates the sine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down Expand Up @@ -964,7 +964,7 @@ namespace Enumerable {
singleOrDefault<U=symbol>(predicateOrDefaultValue?: Predicate<T> | T,
defaultValue?: U): T | U;
/**
* Handles current items as base numbers and calculates the hyperbolic sine for each item.
* Handles current items as numbers and calculates the hyperbolic sine for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down Expand Up @@ -995,7 +995,7 @@ namespace Enumerable {
*/
skipWhile(predicate: Predicate<T>): IEnumerable<T>;
/**
* Handles current items as base numbers and calculates square root for each item.
* Handles current items as numbers and calculates square root for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down Expand Up @@ -1026,7 +1026,7 @@ namespace Enumerable {
*/
takeWhile(predicate: Predicate<T>): IEnumerable<T>;
/**
* Handles current items as base numbers and calculates the tangent for each item.
* Handles current items as numbers and calculates the tangent for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand All @@ -1035,7 +1035,7 @@ namespace Enumerable {
*/
tan(handleAsInt?: boolean): IEnumerable<number>;
/**
* Handles current items as base numbers and calculates the hyperbolic tangent for each item.
* Handles current items as numbers and calculates the hyperbolic tangent for each item.
*
* @param {boolean} [handleAsInt] Handle as integer values (true) or floats (false).
* Default: (false)
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-enumerable",
"version": "3.5.0",
"version": "3.5.1",
"description": "ES6 ready LINQ features written in TypeScript",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 4741255

Please sign in to comment.