Skip to content

Latest commit

 

History

History
138 lines (111 loc) · 3.23 KB

README.md

File metadata and controls

138 lines (111 loc) · 3.23 KB
Raw

GitHub License GitHub package.json version NPM Version npm bundle size

jaqt: javascript queries and transformations

jaqt (pronounced 'jacket') is a query engine for arrays and objects, inspired by graphql and sql. e.g:

Javascript Query Result 
from(data.people)
.select({
    metrics: {
        hair_color: _
    },
    lastName: _
})







 
[
    {
        "metrics": {
            "hair_color": "blond"
        },
        "lastName": "Skywalker"
    },
    {
        "metrics": {
            "hair_color": "none"
        },
        "lastName": "Vader"
    }
]

Table of Contents

  1. Background
  2. Quickstart
  3. Usage
  4. User Manual
  5. Reference
  6. Contributions
  7. License

Background

There are many libraries that add a kind of query language to javascript arrays. GraphQL is one of those. But all the libraries I have found add a custom query language. Either by adding specific functions that mimic SQL, or by explicitly defining a query language like GraphQL. In all cases this means that you give up the power of javascript itself and must switch to a different, less capable language.

So this library is explicitly not a query language itself, but it uses some javascript trickery to add some syntactic sugar to the native Array.map and Array.filter functions so that you can get most of the ease of use of something like GraphQL, while staying squarely in javascript country.

There are no speed improvements or indexes over normal Array.filter and Array.map.

Usage

The examples below all use the data below:

let data = JSON.parse(`[
	{
		"name": "John",
		"lastName": "Doe",
		"friends": [
			"Jane"
		]
	},
	{
		"name": "Jane",
		"lastName": "Doe",
		"friends": [
			"John"
		]
	}
]`)

And this is how you can use this library:

import {from, _} from 'jaqt'

from(data)
.where({
	friends: 'John'
})
.select({
	name: o => o.name+' '+o.lastName
})

Which results in:

[
	{ name: 'Jane Doe'}
]

Documentation

Contributions

Contributions are welcome. Please fork the github repository and make your changes there, then open a pull request. If you find any bugs or other issues, please use the github repository Issues. Check if your issue has already been posted before you add a new issue.

The github repository is at https://github.com/muze-nl/jaqt

License

This software is licensed under MIT open source license. See the License file.