liveql

LiveQL library for live queries in GraphQL.

Usage no npm install needed!

<script type="module">
  import liveql from 'https://cdn.skypack.dev/liveql';
</script>

README

LiveQL

LiveQL is a library for implementing live queries in GraphQL. We're currently in beta, so use with caution.

It can be difficult to maintain live data in a GraphQL application. There are a couple common strategies. You can request updates from your server at some specified interval (polling). You can use the built-in GraphQL subscription operation with WebSockets, or some other form of pub/sub. There are pros and cons to both, but there are times when neither are a great option. Polling can be inefficient. Event subscription can be tedious if there’s a lot of events that can change data.

LiveQL is most similar to the subscription model. The difference is that instead of subscribing to events that change data, you subscribe directly to the data. This means that regardless of how the data changes, your application can maintain state.

Check out our wiki for more details and documentation!

Getting Started

Install the package:

npm install liveql --save

Read the documentation for setup instructions.

Prerequisites

LiveQL was designed to work with a Node/Express backend and any frontend framework.

Contributing

Please submit issues/pull requests if you have feedback or message the LiveQL team to be added as a contributor: liveqlsoftware@gmail.com

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details