dinoql
A customizable GraphQL style query language for interacting with JavaScript objects. Use dinoql to traverse JavaScript objects the same way you query APIs with GraphQL.
Table of Contents
Installation
dinoql
is available from npm
.
$ npm install dinoql -S
Why ?
The main objective is to use the same idea of GraphQL, however instead of being for API, it will be for javascript objects.
- ♥️ GraphQL syntax.
- 🔫 Safe access (no runtime errors to keys that does not exist).
- ⚡️ Aliases support (You can rename your keys in the query).
- 🌟 Many resolvers implemented by default.
- 🐣 Build your own resolver.
- 💥 Fragments support(share piece of query logic).
- 👂 Variables support(dynamic queries).
- 🏄 Parse your queries in build time. (Example)
- 🎒 Filter values according to the value.
- 💾 Caching support
- 🔥 Customizable.
Documentation
All examples are using this data:
const data = requests: products: users: name: 'Victor Igor' id: "100" age: 40 name: 'Kant Jonas' id: "200" age: 35 friends: name: 'Kátia' id: "300" age: 10
Getting only name from users
const users = ` requests { users { name } }` console //{ users: [{ name: 'Victor Igor' }, { name: 'Kant Jonas' }] }
Get user by id
const users = ` requests { users(id: "200") { name } }` console //{ users: [{ name: 'Kant Jonas' }] }
Aliases - Renaming keys
const users = ` requests { changeUsers: users(id: "200") { name } }` console //{ changeUsers: [{ name: 'Kant Jonas' }] }
Variables
Build dynamic queries with variables.
const data = users: name: 'Victor Igor' id: "100" age: 18 name: 'Paul Gilbert' id: "200" age: 35 ; const variables = id: "100"; const gql = ` users(id: $id) { name }` // { users: [{ name: 'Victor Igor' }] }
Conditions to get fields
You can create conditions to get a field.
const data = dashboard: value: '#54' name: 'Vic'; const variables = cond: false; const gql = ` dashboard(if: $cond) { value }, name}`;//{ name: 'Vic' } const otherGql = ` dashboard(unless: $cond) { value }, name}`;//{ name: 'Vic', value: '#54' }
Keep key from object
Sometimes, we need to keep specific keys.
const data = requests: user: name: text: 'Dinoql' description: text: 'I am dinoql.'
If you wanna keep some keys, like:
//{ user: { name: 'Dinoql', description: 'I am dinoql.'} }
You can use (keep: true)
in key, like:
//keeping user keyconst user = ` requests { user(keep: true) { name { name: text }, description { description: text } } }`//{ user: { name: 'Dinoql', description: 'I am dinoql.'} }
Resolvers
Resolvers provide the instructions for turning a dinoQL operation into data.
Order by
const users = ` requests { users(orderBy: age) { name, age } }` console //{ users: [{ name: 'Kant Jonas', age: 35 }, { name: 'Victor Igor', age: 40 }] }
Merge
You can merge array or objects.
Array
const data = requests: users: id: 10 age: 10 const variables = user: id: 15 age: 40 const users = ` requests { users(merge: $user) { age } }` console //{ users: [{ age: 10 }, { age: 40 }] }
Object
const data = requests: user: id: 10 name: 'Victor Igor' const variables = user: age: 40 const user = ` requests { user(merge: $user) }` console //{ user: { id: 10, name: 'Victor Igor', age: 40 } }
Default value
You can add default value to keys not found or values (null/undefined).
const users = ` requests { notfound(defaultValue: "Hello") }` console // {notfound: "Hello"}
Parse to Number
const users = ` requests { users { id(toNumber: 1) } }` console //{ users: [{ id: 100 }, { id: 200 }] }
Get object values
const data = requests: user: name: 'vic' age: 10 const gql = ` requests { user(getObjectValues: true) }` console //['vic', 10]
Parse to array
const data = requests: fields: field1: 'name' field2: 'age' const users = ` requests { fields(toArray: true) }` console //[{ field1: 'name' }, { field2: 'age' }]
First
const users = ` requests { users(first: true) { name } }` console //{ users: { name: 'Victor Igor' } }
Last
const users = ` requests { users(last: true) { name } }` console //{ users: { name: 'Kant Jonas' } }
Get Prop
const newData = requests: users: id: 10 name: 'Victor Fellype' information: title: text: 'my title' description: text: 'my description' ;
without getProp
const data = ` requests { users { name } information { title { title: text } description { description: text } } }`
with getProp
const data = ` requests { users(getProp: name) information { title(getProp: text) description(getProp: text) } }` console // { users: 'Victor Fellype', title: 'my title', description: 'my description' }
Get Path
const newData = requests: cms: footer_data: social_networks: name: 'facebook' url: 'facebook.com' name: 'instagram' url: 'instagram.com' ;
without getPath
const data = ` requests { cms { footer_data { social_networks } } }`
with getPath
const socialNetworks = ` requests(getPath: "cms.footer_data.social_networks")` console /* { requests: [ { name: 'facebook', url: 'facebook.com' }, { name: 'instagram', url: 'instagram.com' } ] }*/
Building your own resolver
You can create a function to change a value in query.
; const incAge = { const valueToInc = Numberright; return list;}; ; const value = ` requests { users(incAge: 2) { name, age } }`;// { users: [{ name: 'Victor Igor', age: 42 }, { name: 'Kant Jonas', age: 37 }] }
Custom options
Keep structure
const users = ` requests { users(id: "200") { name } }` console/*{ requests: { users: [{ name: 'Kant Jonas' }] }} */
Improve performance 🏄
You can improve performance parsing in build time your queries.
How ?
-
Create files
.graphql
or.gql
and add your queries. -
Import your queries from
.graphql|.gql
# your queries query MyQuery { requests { users }}
//your js; const users = MyQuery
- Setup your webpack - example
Fragments support 💥
You can share piece of query logic.
fragment queryOne on Query { users { name }} fragment queryTwo on Query { products} query Form { requests { ...queryOne, ...queryTwo, friends }}
Organizations and projects using dinoql
⚡️ List of organizations and projects using dinoql
License
The code is available under the MIT License.