transversal-client
v1.0.4
Published
Transversal is an open-source package that aids developers in utilizing GraphQL's dynamic querying language to auto-generate schemas, queries, and mutations on the frontend from the query template initially setup in the backend.Transversal leverages Redis
Downloads
1
Readme
What is Transversal:
Transversal is an open-source package that aids developers in utilizing GraphQL's dynamic querying language to auto-generate schemas, queries, and mutations on the frontend from the query template initially setup in the backend.Transversal leverages Redis' in-memory caching mechanism to quickly reference server-side caching.
Install Transversal:
Implementation:
Frontend Setup:
Get Started
Import TransversalClient and instantiate it with your preferred endpoint to setup WebSocket connection
call the getTransversalInstance() method to get the gql object containing all the queries and mutations templates needed to make API calls and store it in some state where it can be accessed
Making Queries/Mutations
To make your query/mutation API call, call the transversalQuery() method and pass in a few arguments. You would first need to specify the name of the query or mutation, arguments required (that was setup on the backend previously), specify if you want the call to come from the cache or server, and the last argument can be omitted if you want everything to be returned from the api call, if not, you will have to pass in a custom shape(string) for your data to fill.
What’s to come?
The Transversal team will maintain the library, optimizing where optimizable, and iterating on the tool to provide more streamlined offerings to the community.
We will be working on:
Improving performance on large data schemas
Adding support for relational databases
Adding functionality and options advancing caching
… and much more
Our hope is that we are not only saving our own time but saving the community's time as well. We hope you check out our tool and enjoy the speed and benefits of getting a project off the ground running as much as we do. Consider contributing, craft it to your needs and let us know your experience. Open issues, reach out to the team, we want to hear from you.
Thank you and this wonderful community!
Quick Links
Try Transversal
About us
View Source Code
The Transversal Team
Dan Forrester | GitHub | LinkedIn
Norman Liu | GitHub | LinkedIn
About GraphQL
GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools. -graphql.org
From Back to Front