filter-string

parse and stringify RESTFull filter string

Usage no npm install needed!

<script type="module">
  import filterString from 'https://cdn.skypack.dev/filter-string';
</script>

README

filter-string

node npm license Build Status Standard - JavaScript Style Guide Coverage Status

Parse and stringify RESTFul filter string

Install

npm install filter-string

Use

Stringify

import { stringify } from 'filter-string'

const filters = [
  {
    key: 'a',
    op: 'eq',
    value: 'xxx',
  },
  {
    key: 'b',
    op: 'gt',
    value: 'yyy',
  },
]

const $filter = stringify(filters, {
  op: 'and',
})

// output
// a eq xxx and b gt yyy

Parse

import { parse } from 'filter-string'

const $filter = 'a eq xxx and b gt yyy'

const filters = parse($filter)

// output
// [{
//   key: 'a',
//   op: 'eq',
//   value: 'xxx'
// }, {
//   key: 'b',
//   op: 'gt',
//   value: 'yyy'
// }]

Needed polyfill

Array.prototype.filter
Array.prototype.find

FYI: You should add polyfill by yourself if need

Development

  • Installation
npm install
  • Build for publish
npm run build
  • Run test
npm run test