New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

kuery

Package Overview
Dependencies
Maintainers
0
Versions
21
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

kuery

Kuery =====

  • 0.6.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
0
Created
Source

Kuery

  • Purpose
  • Installation
  • Usage
  • API

Purpose

Simple MongoDB like queries with lodash for in-memory filtering of documents.

Installation

npm i kuery

Usage

import Kuery from 'kuery';

const collection = [
  { id: 1, name: 'Andreas', address: { street: 'Bellmansgatan' } },
  { id: 2, name: 'Sven' },
  { id: 3, name: 'Christian' },
  { id: 4, name: 'Emil' }
];

const idListKuery = new Kuery({ id: { $in: [3, 2] } });
const people = idListKuery.find(collection);
// Result: [{ id: 2, name: 'Sven' }, { id: 3, name: 'Christian' }]

const nestedPathKuery = new Kuery({ 'address.street': 'Bellmansgatan' });
const peopleOnMellmansgatan = nestedPathKuery.find(collection);
// Result: [{ id: 1, name: 'Andreas', address: { street: 'Bellmansgatan' }}]

API

Constructor

Creates a new Kuery constructor with query. Takes a filter query as argument to be executed against provided lists.

const kuery = new Kuery({ id: { $in: [3, 2] } });

Methods

skip

Skips the provided amount of documents from the collection

const kuery = new Kuery({ id: { $in: [1, 2] } });
kuery.skip(1);

const result = kuery.find([{ id: 1 }, { id: 2 }, { id: 3 }]);
// Result: [{ id: 2 }]

limit

Limits the resulted documents to the provided amount

const kuery = new Kuery({ id: { $in: [1, 2] } });
kuery.limit(1);

const result = kuery.find([{ id: 1 }, { id: 2 }, { id: 3 }]);
// Result: [{ id: 1 }]

sort

Sorts the returned documents based on the provided key(s)

const kuery = new Kuery({ id: { $in: [1, 2] } });
kuery.sort({ id: 0 });

const result = kuery.find([{ id: 1 }, { id: 2 }, { id: 3 }]);
// Result: [{ id: 2 }, { id: 1 }];

find

Returns the documents matching the query in the provided collection

const kuery = new Kuery({ id: { $in: [1, 2] } });
const result = kuery.find([{ id: 1 }, { id: 2 }, { id: 3 }]);
// Result: [{ id: 1 }, { id: 2 }]

findOne

Returns the document matching the query in the provided collection. Throws an Error if not exactly one document is found.

const collection = [{ id: 1, name: 'Andreas' }, { id: 2, name: 'Andreas' }, { id: 3, name: 'Christian' }];

try {
  const kuery = new Kuery({ name: 'Christian' });
  const result = kuery.findOne([{ id: 1 }, { id: 2 }, { id: 3 }]);
  // Result: { id: 3, name: 'Christian' }  
} catch (err) {
  // No error
}

try {
  const kuery = new Kuery({ name: 'Andreas' });
  const result = kuery.findOne(collection);
} catch (err) {
  // err.message: 'findOne returned 2 results.'
}

try {
  const kuery = new Kuery({ name: 'Gustav' });
  const result = kuery.findOne(collection);
} catch (err) {
  // err.message: 'findOne returned 0 results.'
}

FAQs

Package last updated on 03 Dec 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc