Utility library for use in Sails adapters where you need to filter a list of output using a criteria object
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
test
.editorconfig
.gitignore
.npmignore
.travis.yml
Gruntfile.js
README.md
bower.json
index.js
package.json 1.0.1 Jun 6, 2016

README.md

Waterline-Criteria

npm version Build Status Dependency Status

Helper module designed for adapters which communicate with key/value stores such as Sails-Disk, Sails-Memory, and sails-redis (i.e. they already implement the semantic interface, but need to implement the queryable interface)

Contents

Jump to...
I Browser
II Node.js
III Version Notes
IV License

For the Browser

Installation

$ bower install waterline-criteria

Basic Usage

    <!-- .... -->
  </body>
  <script type="text/javascript" src="./path/to/bower_components/waterline-criteria/index.js"></script>
  <script type="text/javascript">
    var someData = [{
      id: 1,
      name: 'Lyra'
    }, {
      id: 2,
      name: 'larry'
    }];

    var x = wlFilter(someData, {
      where: {
        name: { contains: 'lyr' }
      }
    }).results;

    // x ==> [{name: 'Lyra', id: 1}]
  </script>
</html>

For Node.js

Installation

$ npm install waterline-criteria

Basic Usage

var wlFilter = require('waterline-criteria');

var someData = [{
  id: 1,
  name: 'Lyra'
}, {
  id: 2,
  name 'larry'
}];

var x = wlFilter(someData, {
  where: {
    name: { contains: 'lyr' }
  }
}).results;

// x ==> [{name: 'Lyra', id: 1}]

Version Notes

The master branch of this repository holds waterline-criteria for Sails versions 0.10.0 and up. If you're looking for the version for the v0.9.x releases of Sails, the source is located here.

Roadmap

  1. Benchmark
  2. Optimize
  3. There is a possibility that waterline-criteria will eventually become a dependency of Waterline core, since it may make sense to merge the integrator submodule from Waterline core (in-memory populates/joins) into this library.

License

MIT © 2014 Mike McNeil, Balderdash & contributors

This module is part of the Sails framework, and is free and open-source under the MIT License.

image_squidhome@2x.png