Skip to content
This repository has been archived by the owner on Nov 11, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerald Burkholder authored Jan 8, 2018
1 parent 160126a commit f200388
Showing 1 changed file with 2 additions and 288 deletions.
290 changes: 2 additions & 288 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,11 @@

# enumerablejs

a JavaScript library that provides linq functions on native JavaScript arrays

> this project is still under development and is not completely finished.
## Getting Started
> this project is still under development and is not completely finished. [Documentation available here](https://ralphy15.github.io/enumerablejs/)
### yarn
```bash
## install with yarn
$ yarn add asenumerable
```

Expand All @@ -26,286 +23,3 @@ $ bower install enumerablejs
## install with npm
$ npm install asenumerable
```

## How to use
On any native javascript array, simply call asEnumerable() followed by subsequent calls to any
of the methods outlined in this documentation.

## Enumerable
The main type for enumerablejs. Exposes linq style methods for use on javascript arrays.
```javascript
var arr = [{ name:"def", value: 1, description: "test object 2" }];

//the most common way to use enumerable js is to call asEnumerable() on an array
//which returns an instance of an Enumerable object
arr.asEnumerable();

//initialize a new enumerable
var a = new Enumerable();

//or simply initialize an enumerable with an array
var b = new Enumerable(arr);

//enumerable methods are chainable
var c = b.take(1).count(); //c = 1
```

## toArray
converts the enumerable object back to a plain javascript array

```javascript
var arr = [{ name:"def", value: 1, description: "test object 2" }];

//create a new enumerable from the array
var b = new Enumerable(arr);

//convert b to a plain javascript array
var c = b.toArray();
```

## where
Filters a sequence of values based on a predicate.

|Parameter | Description |
| --- | --- |
| fn | A function to test each element for a condition. |

``` javascript

//consider the following array.
var arr = [
{ name:"abc", value: 0, description: "test object 1" },
{ name:"def", value: 1, description: "test object 2" }];


//filter the array where name is equal to "def"
var arr = [];
var result = arr.asEnumerable().where(function (i, item, collection)
{
return item.name === "def";
});


//the result will be an enumerable containing the following array
[{ name:"def", value: 1, description: "test object 2" }]
```

## select
Projects each element of a sequence into a new form.

|Parameter | Description |
| --- | --- |
| properties | A string array of property names to select. |

``` javascript

//consider the following array.
var arr = [
{ name:"abc", value: 0, description: "test object 1" },
{ name:"def", value: 1, description: "test object 2" }];


//select a single property.
var result = arr.asEnumerable().select(["name"]);


//the result will be an enumerable containing the following array.
[{ name: "abc" }, { name: "def" }]


//select multiple properties.
var result = arr.asEnumerable().select(["name", "description"]);


//the result will be an enumerable containing the following array.
[{ name: "abc", description: "test object 1" }, { name: "def", description: "test object 2" }]
```

## orderBy
Sorts the elements of a sequence in ascending order according to a key.

|Parameter | Description |
| --- | --- |
| propertyName | the key by which to order the elements in the enumerable by. propertyName should not be null or undefined. |
| fn | a function applied to each element before performing the order operation. fn can be null or undefined. |

``` javascript

//consider the following array
var arr = [
{ name:"def", value: 0, description: "test object 1" },
{ name:"abc", value: 1, description: "test object 2" }];


//order the items by name
var result = arr.asEnumerable().orderBy("name");


//the result will be an enumerable containing the following array.
[{ name:"abc", value: 1, description: "test object 2" },
{ name:"def", value: 0, description: "test object 1" }];


//or you can use a transform function on each element while sorting by name
var result = arr.asEnumerable().orderBy("name", function(item) { return item.value + 1; });
```

## orderByDescending
Sorts an array of objects in a sequence in descending order according to a key.

|Parameter | Description |
| --- | --- |
| propertyName | the key by which to order the elements in the enumerable by. propertyName should not be null or undefined. |
| fn | a function applied to each element before performing the order operation. fn can be null or undefined. |

```javascript

//consider the following array
var arr = [
{ name:"def", value: 0, description: "test object 1" },
{ name:"abc", value: 1, description: "test object 2" }];


//order by value descending
var result = arr.asEnumerable().orderByDescending("value");


//the result will be an enumerable containing the following array.
[{ name:"abc", value: 1, description: "test object 2" },
{ name:"def", value: 0, description: "test object 1" }]

//or you can use a transform function on each element while sorting by value
var result = arr.asEnumerable().orderByDescending("value", function(item) { return item.value + 1; });
```

## any
Determines whether any element of a sequence satisfies a condition.

``` javascript
//consider the following array
var arr = [];

//result equals false
var result = arr.asEnumerable().any();


```

## count
Returns the number of elements in a sequence.

|Parameter | Description |
| --- | --- |
| fn | A function to test each element for a condition. |

``` javascript
//consider the following array
var arr [{ name: 'test', id: 1 }, { name: 'test', id: 2 }, { name: 'test2', id: 2 }];

//result equals 3
var result = arr.asEnumerable().count();

//or supply a predicate function.
//result equals 2
var result = testArray.count(function(i, item, col)
{
return item.name === 'test';
});
```

## first
Returns the first element of a sequence.

``` javascript
var arr = [];
var result = arr.asEnumerable().first();
```
## firstOrDefault
Returns the first element of a sequence, or a default value if the sequence contains no elements.

``` javascript
var arr = [];
var result = arr.asEnumerable().firstOrDefault();
```

## last
Returns the last element of a sequence.

``` javascript
var arr = [];
var result = arr.asEnumerable().last();
```

## lastOrDefault
Returns the last element of a sequence, or a default value if the sequence contains no elements.

``` javascript
var arr = [];
var result = arr.asEnumerable().lastOrDefault();
```

## single
Returns the only element of a sequence, and throws an exception if there is not exactly one element in the sequence.

``` javascript
var arr = [];
var result = arr.asEnumerable().single();
```

## singleOrDefault
Returns a single, specific element of a sequence, or a default value if that element is not found.

``` javascript
var arr = [];
var result = arr.asEnumerable().singleOrDefault();
```

## take
Returns a specified number of contiguous elements from the start of a sequence.

``` javascript
var arr = [];
var result = arr.asEnumerable().take();
```
## takeWhile
Returns elements from a sequence as long as a specified condition is true.

``` javascript
var arr = [];
var result = arr.asEnumerable().takeWhile(function (i, item, collection)
{
return (item.name === "test");
});
```
## skipWhile
Bypasses elements in a sequence as long as a specified condition is true and then returns the remaining elements.

``` javascript
var arr = [];
var result = arr.asEnumerable().skipWhile(function (i, item, collection)
{
return (item.name === "test");
});
```
## toArray
Converts an enumerable object to a native javascript array.
``` javascript
var enumObj = new Enumerable();

var arr = enumObj.toArray();
```

## minimum
Returns the minimum value in a sequence.

``` javascript
var arr = [];
var result = arr.asEnumerable().minmum();
```
## maximum
Returns the maximum value in a sequence.

``` javascript
var arr = [];
var result = arr.asEnumerable().maximum();
```

0 comments on commit f200388

Please sign in to comment.