Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moinism/faltu
Search sort, filter, limit an array of objects in Mongo-style.
https://github.com/moinism/faltu
array filter javascript mongo-style nodejs objects search sort
Last synced: 2 months ago
JSON representation
Search sort, filter, limit an array of objects in Mongo-style.
- Host: GitHub
- URL: https://github.com/moinism/faltu
- Owner: moinism
- License: mit
- Created: 2016-10-11T13:29:11.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-10-19T20:33:08.000Z (about 8 years ago)
- Last Synced: 2024-10-07T15:18:15.949Z (3 months ago)
- Topics: array, filter, javascript, mongo-style, nodejs, objects, search, sort
- Language: JavaScript
- Size: 10.7 KB
- Stars: 111
- Watchers: 5
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/moinism/faltu)
[](https://coveralls.io/github/moinism/faltu?branch=master)
[](https://badge.fury.io/js/faltu)
[](https://github.com/moinism/faltu/blob/master/LICENSE)
# Faltu
> Search sort, filter, limit and iterate over an array of objects in Mongo-style.
## Installation
In __NodeJS__:
````bash
npm install faltu --save
````
For other projects simply download and include the file in your pages:
````html
````
## Usage
All the data passed is expected to be an array or objects.
e.g:
````
[array, array, ..., array]
````
All the data returned is also of the same type.
For example:
````javascript
var data = [{
name: "John",
age: 16
},{
name: "Doe",
age: 18
},{
name: "Smith",
age: 22
}];
````
Pass the array to constructor:
In __NodeJS__:
````javascript
var Faltu = require('faltu');
var faltuData = new Faltu(data);
````
In other environments:
````javascript
var faltuData = new Faltu(data);
````
### Searching
You can use `find` method for searching.
Search for all the guys who are 18 years of age:
```javascript
var newData = new Faltu(data).find({
age: 18
}).get();
```
`newData` would look something like:
```javascript
[{
name: "Doe",
age: 18
}]
```
You should always call `get` at the end if you want an array back. Or It'll just return the `faltu` instance.
Search for all the guys who are 18 years of age or older:
```javascript
var newData = new Faltu(data).find({
age: {
$gte: 18 // $gte is similar to >= (greater than or equal to)
}
}).get();
```
`newData`:
```javascript
[{
name: "Doe",
age: 18
},{
name: "Smith",
age: 22
}]
```
Other supported comparison operators in `find` are:
- `$lt`: <
- `$lte`: <=
- `$gt`: >
- `$ne`: !=
Search for all the guys who are 18 or 16 years of age:
```javascript
var newData = new Faltu(data).find({
age: [16, 18]
}).get();
```
`newData`:
```javascript
[{
name: "John",
age: 16
},{
name: "Doe",
age: 18
}]
```
Passing `null`, empty object `{}` or nothing to `find` means not performing any search. `find` accepts options as second argument.
e.g:
```javascript
var newData = new Faltu(data).find({
age: [16, 18]
}, {
sort: {
age: -1
}
}).get();
```
Will return the data in descending order by `age`. Other than `sort` you can also pass:
- `skip`
- `limit`
- `unique`
### Sorting
Use `sort` to sort the result in descending order by `age`:
```javascript
var newData = new Faltu(data).find({
age: [16, 18]
}).sort({
age: -1 // 1 = ASC, -1 = DESC
}).get();
```
`newData`:
```javascript
[{
name: "Doe",
age: 18
},{
name: "John",
age: 16
}]
```
### Limit
Let's get only 1 object back:
```javascript
var newData = new Faltu(data).find().limit(1).get();
```
`newData`:
```javascript
[{
name: "John",
age: 16
}]
```
### Skip
Let's skip 1st object:
```javascript
var newData = new Faltu(data).find().skip(1).get();
```
`newData`:
```javascript
[{
name: "Doe",
age: 18
},{
name: "Smith",
age: 22
}]
```
### Skip & Limit
Let's skip 1st object:
```javascript
var newData = new Faltu(data).find().skip(1).limit(1).get();
```
`newData`:
```javascript
[{
name: "Doe",
age: 18
}]
```
### Unique
You can have result returned that is unique by a key.
```javascript
var newData = new Faltu(data).find().unique('age').get();
```
### Filtering
You can also perform `jQuery`-esque filtering yourself. Call `filter` method, pass a `function`.
```javascript
var newData = new Faltu(data).find().filter(function (person) {
return person.age == 16; // return true if you want to keep the object
}).get();
```
`newData`:
```javascript
[{
name: "John",
age: 16
}]
```
### Iterate
`each` iterates over all the records returned.
````javascript
var newData = new Faltu(data).find(null).each(function(person, index){
console.log('User name:', person.name);
});
````