npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@basd/query

v0.0.3

Published

A powerful library that provides a robust and fluent interface to build, parse, and execute queries.

Downloads

34

Readme

Query

npm pipeline license downloads

Gitlab Github Twitter Discord

A powerful JS library that provides a robust and fluent interface to build, parse, and execute queries. Designed with the principles of modularity, the library consists of a collection of classes that work in unison to create complex query expressions, translate them into an Abstract Syntax Tree (AST), and execute them.

Features

  • Supports Various Query Operations: like $eq, $gt, $lte, $in, etc.
  • Extensible: Incorporate OOP principles and design patterns.
  • Fluent API: Chainable methods for intuitive query building.
  • Customizable: Use the Factory to replace or extend the built-in classes.

Installation

Install the package with:

npm install @basd/query

Usage

First, import the Query library.

import Query from '@basd/query'

or

const Query = require('@basd/query')

Create a new Query

const query = new Query({
  // Optional configurations...
})

Build a Query

Using the QueryBuilder class:

const builder = new QueryBuilder()
builder.where('age').gte(18).and().lt(30)
const resultQuery = builder.build()

Parsing a Query

Once you have a built query, use QueryParser to parse it:

const parser = new QueryParser()
const parsed = parser.parse(resultQuery)

Interpreting a Query

Execute a parsed query using the QueryInterpreter:

const interpreter = new QueryInterpreter()
const result = interpreter.interpret(parsed, yourEntity)

Using the Query Engine

To perform database operations like refine, filter, and find:

const engine = new QueryEngine()
engine.find({ age: { $gte: 18, $lt: 30 } })

Documentation

Classes

  • Query: Main class to manage query building, parsing, and execution.
  • QueryBuilder: Helps construct query objects in a fluent manner.
  • QueryParser: Transforms a query object into an abstract syntax tree.
  • QueryInterpreter: Evaluates an entity against the parsed query.
  • QueryVisitor: Visit AST nodes to evaluate them against an entity.
  • QueryFactory: Factory for creating instances of other classes.
  • QueryEngine: Provides higher-level database operations.

Tests

In order to run the test suite, simply clone the repository and install its dependencies:

git clone https://gitlab.com/frenware/framework/plaindb/query.git
cd query
npm install

To run the tests:

npm test

Contributing

Thank you! Please see our contributing guidelines for details.

Donations

If you find this project useful and want to help support further development, please send us some coin. We greatly appreciate any and all contributions. Thank you!

Bitcoin (BTC):

1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF

Monero (XMR):

46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ

License

@basd/query is MIT licensed.