@prodemmi/filterit v1.0.3

FilterIt

FilterIt is a tool that helps you easily parse and build query strings.

Installation

You can install FilterItTool using npm:

npm install filterit

Usage

To use FilterItTool, simply import the FilterIt class and create an instance:

    import { FilterIt, Operator, Direction } from 'filterit';
    
    const filterIt = new FilterIt();

Filtering

    const query: string = filterIt.filterBy('id', Operator.Between, [10, 15])
            .filterBy('name', Operator.EndsWith, "Pour")
            .toQuery();

    console.log(query); // id=between:10`15&name=ends_with:Pour

Sorting

import {Direction} from "filterit";

const query: string = filterIt.sortBy('id', Direction.ASC).toQuery();

console.log(query) // sort_by=id:asc

Parsing query strings

    import { QueryParser, IParsedQuery } from 'filterit';

    const query: string = 'id=not_equal:20|id=between:10`30';
    
    console.log(QueryParser.parseQuery(query));
    // [
    //     {
    //         query: 'id=not_equal:20',
    //         isNestedQuery: false,
    //         delimiter: 'and',
    //         column: 'id',
    //         operator: 'not_equal',
    //         value: '20',
    //     },
    //     {
    //         query: 'id=between:10`30',
    //         isNestedQuery: false,
    //         delimiter: 'or',
    //         column: 'id',
    //         operator: 'between',
    //         value: [
    //             '10',
    //             '30'
    //         ],
    //     },
    // ]

License

FilterItTool is released under the MIT License. See LICENSE for details.