arrayql-js v1.1.3

📦🔍 A "GraphQL" for arrays of objects

Installation

npm i arrayql-js

yarn add arrayql-js

Get started

arrayQL(array, queryOptions)

array: T[]

An array of objects.

queryOptions: QueryOptions\<T>

keys: BooleanKeys\<T> - selects which keys will be in the output. They must be boolean, it doesn't matter if they're true or false.

where?: (object: T) => boolean: - (optional) filter callback that recieves each object and returns a boolean expression.

Considering GraphQL queries features, arrayQL is recursive, which means that you can have objects and arrays nested and it'll work for them as well. In below example, friends is also an array of objects. Attention: array of primitive values, like keywords which is an array of strings, must be selected as boolean, not as QueryOptions.

import { arrayQL } from "arrayql-js";

const normalizedUsers = arrayQL(users, {
  keys: {
    name: true,
    id: true,
    keywords: true,
    address: {
      city: true,
      country: true,
    },
    friends: {
      where: ({ name }) => name.includes("Smith"),
      keys: { id: true },
    },
  },
  where: ({ age }) => age > 23,
});

Don't worry, arrayQL has a nice type definition, it will infer the shape of your object, then your editor will do the rest.

With ES6

You can obtain the same result with usual .map() and .filter(). But it is a bit more complex, especially when things get nested 😅.

const withES6 = users
  .filter(({ age }) => age > 23)
  .map(({ name, id, keywords, address: { city, country }, friends }) => ({
    name,
    id,
    keywords,
    address: { city, country },
    friends: friends
      .filter(({ name }) => name.includes("Smith"))
      .map(({ id }) => ({ id })),
  }));

Now you know how to start, just go and query your arrays 😃.

Contribute

You are able to share your ideas or propose changes/features. Some problems are open to get a resolution:

• Infer the types of the returned array, if possible, of course.
• Check input errors (invalid object | array structure).
• 🤔 Build a mutation option. Am I too crazy? I mean, who's gonna use it, anyway?

Let's say you want to help, one thing is important: the root index.d.ts file has to be manually copied to lib/ folder after TS to JS compilation with tsc. 🤷‍♂️ Let's change this as well, I'm not any tsconfig.json master. But before doing this, just yarn the project dependencies and don't forget to test your implementations 😎.