js-criteria

js-criteria


#### Motivation

Aims to be a complete solution for query on json and javascript map objects.

#### Type Docs

#### Installation

``bash
npm install --save js-criteria
`

#### Usage

- Criteria :
Provides to create criteria on json.
- CriteriaResult :
Holds criteria result.
- Order :
Provides to ordering on Criteria.
- Property :
Provides to select property on Criteria.
- Restrictions :
Provides to filter on Criteria.

* import
`typescript
import {Criteria, Order, Restrictions} from "js-criteria";
`


* operate on Criteria

`typescript
const result = criteria
.setLimit(10)
.setOffset(0)
.sort("age", OrderType.asc)
.asc("name")
.desc("surname")
.isTrue("enabled")
.isFalse("deleted")
.isNull("name")
.isNotNull("name")
.eq("name", "sample")
.neq("name", "sample")
.gt("age", 18)
.gte("age", 18)
.lt("age", 18)
.lte("age", 18)
.between("age", 18, 24)
.like("name", "sample")
.likeIn("name", ["sample"])
.in("name", ["sample"])
.startsWith("name", "sample")
.endsWith("name", "sample")
.query("sample")
.list();
console.log(result.total);
console.log(result.data);
`

* add restriction

`typescript

const data = [
{
name: "Nami",
age: 16,
},
{
name: "Monkey D. Luffy",
age: 16,
},
{
name: "Gol D. Roger",
age: 32,
},
{
name: "Chopper",
age: 16,
}
];

const criteria = new Criteria(data);
criteria.add(Restrictions.eq("name", "Gol D. Roger"));
let result = criteria.list();
console.log(result.total);
console.log(result.data);

criteria.clear();
criteria.add(Restrictions.eq("age", 16));
result = criteria.list();
console.log(result.total);
console.log(result.data);

criteria.clear();
criteria.add(Restrictions.eq("age", 16));
result = criteria.list();
console.log(result.total);
console.log(result.data);
`

* add order

`typescript
const data = [
{
name: "Nami",
age: 16,
},
{
name: "Monkey D. Luffy",
age: 16,
},
{
name: "Gol D. Roger",
age: 32,
},
{
name: "Chopper",
age: 16,
},
];

const criteria = new Criteria(data);
criteria.addOrder(Order.asc("name"));
let result = criteria.list();
console.log(result.total);
console.log(result.data);

`


* add query

`typescript
const data: any = [
{
name: "Nami",
age: 16,
},
{
name: "Monkey D. Luffy",
age: 16,
},
{
name: "Gol D. Roger",
age: 32,
},
{
name: "Chopper",
age: 16,
},
];

let criteria = new Criteria(data);
criteria.add(Restrictions.query("o"));
let result = criteria.list();
console.log(result.total);
console.log(result.data);

const data2: any = [
{id: 1, name: "John", surname: "Doe"},
{name: "Jane", surname: "Roe", id: 2},
];

criteria2 = new Criteria(data2);
criteria2.addQuery(Restrictions.query("J"));
let result2 = criteria.list();
console.log(result2.total);
console.log(result2.data);
`


* reset criteria as initial state.

`typescript

const criteria = new Criteria(data);

criteria.add(Restrictions.eq("name", "Gol D. Roger"));
criteria.addOrder(Order.asc("name"));

let result = criteria.list();

console.log(result.total);
console.log(result.data);

// reset criteria
criteria.clear();

result = criteria.list();

console.log(result.total);
console.log(result.data); // show all data.

`


* All methods defined on Criteria

- public get offset()
- public setOffset(firstResult: number): Criteria
- public get limit()
- public setLimit(limit: number): Criteria
- public sort(name: string, orderType: OrderType): Criteria
- public asc(name: string): Criteria
- public desc(name: string): Criteria
- public isTrue(name: string): Criteria
- public isFalse(name: string): Criteria
- public isNull(name: string): Criteria
- public isNotNull(name: string): Criteria
- public eq(name: string, value: any, caseSensitive?: boolean): Criteria
- public neq(name: string, value: any, caseSensitive?: boolean): Criteria
- public gt(name: string, value: any): Criteria
- public gte(name: string, value: any): Criteria
- public lt(name: string, value: any): Criteria
- public lte(name: string, value: any): Criteria
- public between(name: string, leftValue: any, rightValue: any): Criteria
- public like(name: string, value: any, caseSensitive?: boolean): Criteria
- public likeIn(name: string, values: any[], caseSensitive?: boolean): Criteria
- public in(name: string, values: any[], caseSensitive?: boolean): Criteria
- public startsWith(name: string, value: any, caseSensitive?: boolean): Criteria
- public endsWith(name: string, value: any, caseSensitive?: boolean): Criteria
- public query(value: any, ignoreList?: string[]): Criteria
- public addOrder(orderItem: OrderItem): Criteria
- public removeOrder(key: string): Criteria
- public clearOrder(): Criteria
- public get total(): number
- public add(restriction: RestrictionItem): Criteria
- public removeRestrictionByKey(key: string): Criteria
- public removeRestriction(key: string, op: string): Criteria
- public clearRestriction(): Criteria
- public list(): CriteriaResult
- public clear(): Criteria`

#### LICENSE

The MIT License (MIT)

Copyright (c) 2016 Robe

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.