Have ideas to improve npm?Join in the discussion! »

    obop

    0.2.1 • Public • Published

    obop

    npm version Node.js CI

    MongoDB-style object operators makes array manipulation easy: where/order/update/view

    SYNOPSIS

    Node.js Environment

    const obop = require('obop')();
    const src = [ { a: 1 }, { a: 2 }, { a: 3 } ];
    const out = obop.where( src, { a: 2 } ); // => [ { a: 2 } ]

    Install obop module via npm.

    Browser Envorinment

    <script src="obop.min.js"></script>
    <script>
      const src = [ { a: 1 }, { a: 2 }, { a: 3 } ];
      const out = obop.where( src, { a: 2 } ); // => [ { a: 2 } ]
    </script>

    Download obop.min.js browser build of this module.

    METHODS

    See document for more detail.

    Query Selectors

    where() method supports the following query selectors:

    { field: value }                            // equal to
    { field: { $gt: value } }                   // greater than
    { field: { $gte: value } }                  // greater than or equal to
    { field: { $in: [value1, value2, ... ] } }  // in
    { field: { $lt: value } }                   // less than
    { field: { $lte: value } }                  // less than or equal to
    { field: { $ne: value } }                   // not equal to
    { field: { $nin: [ value1, value2 ... ]} }  // not in
    { $or: [ { query1 }, { qury2 }, ... ] }     // logical OR
    { $and: [ { query1 }, { query2 }, ... ] }   // logical AND
    { field: { $not: { query } } }              // not
    { field: { $exists: boolean } }             // exists
    { field: { $size: value } }                 // array size

    Example:

    const out1 = obop.where( src1, { genre: 'fruit', price: { $gt: 100, $gt: 200 } } );
    const out2 = obop.where( src2, { 'review.score': { $gte: 4.0 } } );

    Sort Parameters

    order() method supports the following styles of sort parameters:

    { field: 1 }                                // ascending
    { field: -1 }                               // descending
    { field1: 1, field2: -1, ... }              // combination
    [ [ 'field1', 1 ], [ 'field2', -1 ], ... ]  // array style

    Example:

    const out1 = obop.order( src1, { price: 1, stock: -1 } );
    const out2 = obop.order( src2, [['price', 1], ['stock', -1]] ); // same as above

    Update Operators

    update() method supports the following update operators:

    { $set: { field: value } }                  // set value
    { $unset: { field: '' } }                   // remove field
    { $rename: { oldname: newname } }           // rename field
    { $inc: { field: amount } }                 // increment value
    { $pull: { field: query } }                 // remove item from array
    { $push: { field: value } }                 // add item to array

    Example:

    const out1 = obop.update( src1, { $inc: { stock: -1 }, $set: { 'review.score': 4 } } );
    const out2 = obop.update( src2, { $unset: { order: '' } } );

    Projection Parameters

    view() method supports the following styles of projection parameters:

    { field1: 1 }                               // output fields1 only
    { field1: 1, field2: 1, ... }               // output fields1, 2 and more
    { field1: 0 }                               // output all fields except for fields1
    { field1: 0, field2: 0, ... }               // except fields1, 2 and more

    Example:

    const out1 = obop.view( src1, { name: 1, price: 1, stock: 1 } );  // include fields
    const out2 = obop.view( src2, { _id: 0, secret: 0 } );            // exclude fields

    LINKS

    LICENCE

    Copyright 2013-2021 @kawanet

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i obop

    DownloadsWeekly Downloads

    7,068

    Version

    0.2.1

    License

    MIT

    Unpacked Size

    43.1 kB

    Total Files

    12

    Last publish

    Collaborators

    • avatar