# queryl

> Query language to perform complex object searches

Latest version **1.1.0** (published 2016-08-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install queryl
pnpm add queryl
yarn add queryl
bun add queryl
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2016-08-02 |
| First published | 2015-09-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Juan Cruz Viotti |
| Maintainers | jviotti |
| Keywords | query, object, javascript, json, search |

## Links

- npm: https://www.npmjs.com/package/queryl
- Repository: https://github.com/jviotti/queryl
- Issues: https://github.com/jviotti/queryl/issues
- npm.io page: https://npm.io/package/queryl

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.14.1

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.0 (latest) — 2016-08-02
- 1.0.0 — 2015-09-18

## README

queryl
======

> Query language to perform complex object searches.

[![npm version](https://badge.fury.io/js/queryl.svg)](http://badge.fury.io/js/queryl)
[![dependencies](https://david-dm.org/jviotti/queryl.svg)](https://david-dm.org/jviotti/queryl.svg)
[![Build Status](https://travis-ci.org/jviotti/queryl.svg?branch=master)](https://travis-ci.org/jviotti/queryl)
[![Build status](https://ci.appveyor.com/api/projects/status/3d3rxla0oartoh5p/branch/master?svg=true)](https://ci.appveyor.com/project/jviotti/queryl/branch/master)

Description
-----------

Queryl allows to to build complex queries to match JavaScript objects. This can be useful to:

- Search collections of objects (even heterogeneus).
- Validate objects.
- Assert properties of an object for testing purposes.

Installation
------------

Install `queryl` by running:

```sh
$ npm install --save queryl
```

Documentation
-------------

<a name="module_queryl.match"></a>

### queryl.match(query, object) ⇒ <code>Boolean</code>
**Kind**: static method of <code>[queryl](#module_queryl)</code>  
**Summary**: Query an object  
**Returns**: <code>Boolean</code> - whether it matches or not  
**Access:** public  

| Param | Type | Description |
| --- | --- | --- |
| query | <code>Object</code> | query |
| object | <code>Object</code> | object |

**Example**  
```js
queryl.match({
  $or: {
    $equal: {
      foo: 'bar'
    },
    $and: {
      $not: {
        $match: {
          foo: /^baz/
        }
      },
      $gt: {
        bar: 3
      }
    }
  }
}, {
  foo: 'hello world',
  bar: 5
});
> true
```

Operations
----------


* [operations](#operations) : <code>object</code>
    * [.$and()](#operations.$and)
    * [.$or()](#operations.$or)
    * [.$not()](#operations.$not)
    * [.$equal()](#operations.$equal)
    * [.$contain()](#operations.$contain)
    * [.$match()](#operations.$match)
    * [.$gt()](#operations.$gt)
    * [.$lt()](#operations.$lt)

<a name="operations.$and"></a>

### operations.$and()
**Kind**: static method of <code>[operations](#operations)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| $and | <code>function</code> | logical conjunction |

**Example**  
```js
queryl.match({
  $and: {
    $equal: {
      foo: 'bar'
    },
    $match: {
      bar: /^hello/
    }
  }
}, {
  foo: 'bar',
  bar: 'hello world'
});
> true
```
<a name="operations.$or"></a>

### operations.$or()
**Kind**: static method of <code>[operations](#operations)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| $or | <code>function</code> | logical disjunction |

**Example**  
```js
queryl.match({
  $or: {
    $equal: {
      foo: 'bar'
    },
    $match: {
      bar: /^hello/
    }
  }
}, {
  foo: 'bar',
  bar: 'hey there'
});
> true
```
<a name="operations.$not"></a>

### operations.$not()
**Kind**: static method of <code>[operations](#operations)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| $not | <code>function</code> | logical negation |

**Example**  
```js
queryl.match({
  $not: {
    $equal: {
      foo: 'bar'
    }
  }
}, {
  foo: 'baz'
});
> true
```
<a name="operations.$equal"></a>

### operations.$equal()
This operation supports deep equality.

**Kind**: static method of <code>[operations](#operations)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| $equal | <code>function</code> | equality |

**Example**  
```js
queryl.match({
  $equal: {
    foo: 'bar'
  }
}, {
  foo: 'bar'
});
> true
```
<a name="operations.$contain"></a>

### operations.$contain()
This operation supports deep equality.

**Kind**: static method of <code>[operations](#operations)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| $contain | <code>function</code> | collection include |

**Example**  
```js
queryl.match({
  $contain: {
    foo: 1
  }
}, {
  foo: [ 1, 2, 3 ]
});
> true
```
<a name="operations.$match"></a>

### operations.$match()
**Kind**: static method of <code>[operations](#operations)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| $match | <code>function</code> | RegExp match |

**Example**  
```js
queryl.match({
  $match: {
    foo: /^hello/
  }
}, {
  foo: 'hello world'
});
> true
```
<a name="operations.$gt"></a>

### operations.$gt()
**Kind**: static method of <code>[operations](#operations)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| $gt | <code>function</code> | greater than |

**Example**  
```js
queryl.match({
  $gt: {
    foo: 5
  }
}, {
  foo: 6
});
> true
```
<a name="operations.$lt"></a>

### operations.$lt()
**Kind**: static method of <code>[operations](#operations)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| $lt | <code>function</code> | less than |

**Example**  
```js
queryl.match({
  $lt: {
    foo: 5
  }
}, {
  foo: 4
});
> true
```

Support
-------

If you're having any problem, please [raise an issue](https://github.com/jviotti/queryl/issues/new) on GitHub and I'll be happy to help.

Tests
-----

Run the test suite by doing:

```sh
$ gulp test
```

Contribute
----------

- Issue Tracker: [github.com/jviotti/queryl/issues](https://github.com/jviotti/queryl/issues)
- Source Code: [github.com/jviotti/queryl](https://github.com/jviotti/queryl)

Before submitting a PR, please make sure that you include tests, and that [jshint](http://jshint.com) runs without any warning:

```sh
$ gulp lint
```

License
-------

The project is licensed under the MIT license.

---
_Source: https://npm.io/package/queryl · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._