npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

objection-find-query-builder

1.9.0 • Public • Published

objection-find-query

Based on original work by AFM Sayem - https://github.com/afm-sayem/objection-find-query

Construct complex api query on the frontend, for endpoints implementing objection-find.

Usage:

Builder


const queryBuilder = require('objection-find-query-builder');

const builder = queryBuilder.builder();
const formattedParams = builder.greaterThan('field', 1).lessThan('field', 3).build();

Eager param mutation


const eagerUtils = require('objection-find-query-builder').eagerUtils;

const modifiedParamsRemoved = eagerUtils.removeFromEagerParam('[param1,param2,param3]', 'param2');
const modifiedParamsAppended = eagerUtils.appendToEagerParam('[param1]', 'param2');

Manual formatting

 
/*
  expected format:
  {
    op: {
      column: value
    }
  }
 
  sample input:
  {
    gt: {
      released: 1953,
      gross_income: 200000,
      actors: {
        age: 23
      }
    },
    lt: {
      released: 1984
    },
    in: {
      ratings: [3, 4]
    }
  }
 
  output:
  {
    'released:gt': 1953,
    'gross_income:gt': 200000,
    'actors.age:gt': 23,
    'released:lt': 1984,
    'ratings:in': 3,4
  }
*/
 
const queryBuilder = require('objection-find-query-builder');
const formattedParams = queryBuilder.format(params);
 

Supported operations:

  • greaterThan
  • lessThan
  • greaterThanOrEqual
  • lessThanOrEqual
  • equal
  • inSet (value equals to any value in a given array)
  • anyLike (value of any specified fields matches given string with optional wildcards)
  • anyLikeLower (value of any specified fields matches given string with optional wildcards - case insensitive)
  • eager (retrieve entities from specified relationship eagerly)
  • orderByAsc
  • orderByDesc
  • groupBy
  • count
  • rangeStart
  • rangeEnd

Installation

npm install objection-find-query-builder

install

npm i objection-find-query-builder

Downloadsweekly downloads

72

version

1.9.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
Report a vulnerability