https://github.com/titarenko/knex-filter

Declarative filtering for knex.
https://github.com/titarenko/knex-filter

Last synced: about 1 month ago
JSON representation

Declarative filtering for knex.

• Host: GitHub
• URL: https://github.com/titarenko/knex-filter
• Owner: titarenko
• Created: 2015-07-27T18:14:16.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T01:27:21.000Z (almost 2 years ago)
• Last Synced: 2024-12-02T05:31:10.973Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 238 KB
• Stars: 13
• Watchers: 3
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# knex-filter

Declarative filtering for `knex.js`.

[![Build Status](https://secure.travis-ci.org/titarenko/knex-filter.png?branch=master)](https://travis-ci.org/titarenko/knex-filter) [![Coverage Status](https://coveralls.io/repos/titarenko/knex-filter/badge.png)](https://coveralls.io/r/titarenko/knex-filter)

[![NPM](https://nodei.co/npm/knex-filter.png?downloads=true&stars=true)](https://nodei.co/npm/knex-filter/)

## Installation

```bash

npm i knex-filter --save

```

## Usage

```js

var filter = require('knex-filter').filter;

knex('mytab')

	.where(filter({

		a: 'b',

		'c >': 12,

		'd in': [1, 2, 3],

		e: null,

		not: { f: null },

		or: {

			k: 1,

			'm like': '%Bob%'

		}

	}))

	.then(console.log);

```

## Motivation

Imagine you have page with filterable table, user changes state of your filter controls and presses "apply": you need to pass that filter to backend to obtain filtered set from it. I'm sure you had such case. Was it tedious to walk trough query string and imperatively build your query using `knex.js`? Forget it, you can now provide filter object from your frontend to your backend and apply it with no effort!

## License

MIT